doc/networking.texinfo

   1 @menu
   2 * Networking Overview::
   3 * Sockets::
   4 * Addresses::
   5 * DNS::
   6 * Services::
   7 * Protocols::
   8 * Network Interfaces::
   9 @end menu
  10
  11 @node Networking Overview
  12 @section Overview
  13
  14 Describe networking here.
  15
  16 @node Sockets
  17 @section Sockets
  18
  19 @menu
  20 * Socket Classes::
  21 * Socket Operators::
  22 * Socket Accessors::
  23 * Socket Predicates::
  24 * Socket Options::
  25 @end menu
  26
  27 @node Socket Classes
  28 @subsection Socket Classes
  29
  30 @include include/class-sockets-socket.texinfo
  31 @include include/class-sockets-stream-socket.texinfo
  32 @include include/class-sockets-datagram-socket.texinfo
  33 @include include/class-sockets-internet-socket.texinfo
  34 @include include/class-sockets-local-socket.texinfo
  35 @include include/class-sockets-active-socket.texinfo
  36 @include include/class-sockets-passive-socket.texinfo
  37 @include include/class-sockets-socket-stream-internet-active.texinfo
  38 @include include/class-sockets-socket-stream-internet-passive.texinfo
  39 @include include/class-sockets-socket-stream-local-active.texinfo
  40 @include include/class-sockets-socket-stream-local-passive.texinfo
  41 @include include/class-sockets-socket-datagram-internet-active.texinfo
  42 @include include/class-sockets-socket-datagram-local-active.texinfo
  43
  44 @node Socket Operators
  45 @subsection Socket Operators and Macros
  46
  47 @include include/fun-sockets-make-socket.texinfo
  48 @include include/macro-sockets-with-open-socket.texinfo
  49 @include include/fun-sockets-make-socket-from-fd.texinfo
  50 @include include/fun-sockets-make-socket-pair.texinfo
  51 @include include/fun-sockets-send-to.texinfo
  52 @include include/fun-sockets-receive-from.texinfo
  53 @include include/fun-sockets-bind-address.texinfo
  54 @include include/fun-sockets-listen-on.texinfo
  55 @include include/fun-sockets-accept-connection.texinfo
  56 @include include/macro-sockets-with-accept-connection.texinfo
  57 @include include/fun-sockets-connect.texinfo
  58 @include include/fun-sockets-disconnect.texinfo
  59 @include include/fun-sockets-shutdown.texinfo
  60 @include include/fun-sockets-send-file-descriptor.texinfo
  61 @include include/fun-sockets-receive-file-descriptor.texinfo
  62
  63 @node Socket Accessors
  64 @subsection Socket Accessors
  65 @include include/fun-sockets-socket-os-fd.texinfo
  66 @include include/fun-sockets-socket-type.texinfo
  67 @include include/fun-sockets-socket-protocol.texinfo
  68 @include include/fun-sockets-socket-address-family.texinfo
  69 @include include/fun-sockets-local-name.texinfo
  70 @include include/fun-sockets-local-host.texinfo
  71 @include include/fun-sockets-local-port.texinfo
  72 @include include/fun-sockets-local-filename.texinfo
  73 @include include/fun-sockets-remote-name.texinfo
  74 @include include/fun-sockets-remote-host.texinfo
  75 @include include/fun-sockets-remote-port.texinfo
  76 @include include/fun-sockets-remote-filename.texinfo
  77
  78 @node Socket Predicates
  79 @subsection Socket Predicates
  80 @include include/fun-sockets-socket-open-p.texinfo
  81 @include include/fun-sockets-socket-connected-p.texinfo
  82 @include include/fun-sockets-socket-ipv6-p.texinfo
  83
  84 @node Socket Options
  85 @subsection Socket Options
  86
  87 @node Addresses
  88 @section Socket Addresses
  89
  90 @menu
  91 * Address Objects::
  92 * Address Predicates::
  93 * Address Arithmetic::
  94 * Low-level Address Manipulation::
  95 @end menu
  96
  97 @node Address Objects
  98 @subsection Address Objects
  99
 100 @menu
 101 * Address Classes::
 102 * Address Functions::
 103 * Address Constants::
 104 @end menu
 105
 106 @node Address Classes
 107 @subsubsection Classes
 108
 109 @include include/class-sockets-address.texinfo
 110 @include include/class-sockets-inet-address.texinfo
 111 @include include/class-sockets-ipv4-address.texinfo
 112 @include include/class-sockets-ipv6-address.texinfo
 113 @include include/class-sockets-local-address.texinfo
 114
 115 @node Address Functions
 116 @subsubsection Functions
 117
 118 @include include/fun-sockets-make-address.texinfo
 119 @include include/fun-sockets-copy-address.texinfo
 120 @include include/fun-sockets-ensure-address.texinfo
 121 @include include/fun-sockets-address-to-string.texinfo
 122 @include include/fun-sockets-address-to-vector.texinfo
 123
 124 @node Address Constants
 125 @subsubsection Constants
 126
 127 @include include/constant-sockets-plus-ipv4-loopback-plus.texinfo
 128 @include include/constant-sockets-plus-ipv4-unspecified-plus.texinfo
 129 @include include/constant-sockets-plus-ipv6-interface-local-all-nodes-plus.texinfo
 130 @include include/constant-sockets-plus-ipv6-interface-local-all-routers-plus.texinfo
 131 @include include/constant-sockets-plus-ipv6-link-local-all-nodes-plus.texinfo
 132 @include include/constant-sockets-plus-ipv6-link-local-all-routers-plus.texinfo
 133 @include include/constant-sockets-plus-ipv6-loopback-plus.texinfo
 134 @include include/constant-sockets-plus-ipv6-site-local-all-routers-plus.texinfo
 135 @include include/constant-sockets-plus-ipv6-unspecified-plus.texinfo
 136 @c @include include/constant-sockets-plus-any-host-plus.texinfo
 137 @c @include include/constant-sockets-plus-loopback-plus.texinfo
 138
 139 @node Address Predicates
 140 @subsection Address Predicates
 141
 142 @include include/fun-sockets-addressp.texinfo
 143 @include include/fun-sockets-address=.texinfo
 144 @include include/fun-sockets-address-equal-p.texinfo
 145 @include include/fun-sockets-ipv4-address-p.texinfo
 146 @include include/fun-sockets-ipv6-address-p.texinfo
 147 @include include/fun-sockets-local-address-p.texinfo
 148 @include include/fun-sockets-abstract-address-p.texinfo
 149 @include include/fun-sockets-address-type.texinfo
 150 @include include/fun-sockets-inet-address-loopback-p.texinfo
 151 @include include/fun-sockets-inet-address-multicast-p.texinfo
 152 @include include/fun-sockets-inet-address-type.texinfo
 153 @include include/fun-sockets-inet-address-unicast-p.texinfo
 154 @include include/fun-sockets-inet-address-unspecified-p.texinfo
 155 @include include/fun-sockets-ipv6-admin-local-multicast-p.texinfo
 156 @include include/fun-sockets-ipv6-global-multicast-p.texinfo
 157 @include include/fun-sockets-ipv6-global-unicast-p.texinfo
 158 @include include/fun-sockets-ipv6-interface-local-multicast-p.texinfo
 159 @include include/fun-sockets-ipv6-ipv4-mapped-p.texinfo
 160 @include include/fun-sockets-ipv6-link-local-multicast-p.texinfo
 161 @include include/fun-sockets-ipv6-link-local-unicast-p.texinfo
 162 @include include/fun-sockets-ipv6-multicast-type.texinfo
 163 @include include/fun-sockets-ipv6-organization-local-multicast-p.texinfo
 164 @include include/fun-sockets-ipv6-reserved-multicast-p.texinfo
 165 @include include/fun-sockets-ipv6-site-local-multicast-p.texinfo
 166 @include include/fun-sockets-ipv6-site-local-unicast-p.texinfo
 167 @include include/fun-sockets-ipv6-solicited-node-multicast-p.texinfo
 168 @include include/fun-sockets-ipv6-transient-multicast-p.texinfo
 169 @include include/fun-sockets-ipv6-unassigned-multicast-p.texinfo
 170 @include include/fun-sockets-ipv6-unicast-type.texinfo
 171
 172 @node Address Arithmetic
 173 @subsection Address Arithmetic
 174 @include include/fun-sockets-make-netmask.texinfo
 175 @include include/fun-sockets-ensure-netmask.texinfo
 176 @include include/fun-sockets-inet-address-network-portion.texinfo
 177 @include include/fun-sockets-inet-address-host-portion.texinfo
 178 @include include/fun-sockets-inet-address-in-network-p.texinfo
 179 @include include/fun-sockets-inet-addresses-in-same-network-p.texinfo
 180 @include include/fun-sockets-inet-address-network-class.texinfo
 181 @include include/fun-sockets-inet-address-private-p.texinfo
 182
 183 @node Low-level Address Manipulation
 184 @subsection Low-level Address Manipulation
 185
 186 @include include/constant-sockets-plus-max-ipv4-value-plus.texinfo
 187 @include include/fun-sockets-dotted-to-integer.texinfo
 188 @include include/fun-sockets-integer-to-dotted.texinfo
 189 @include include/fun-sockets-vector-to-integer.texinfo
 190 @include include/fun-sockets-integer-to-vector.texinfo
 191 @include include/fun-sockets-dotted-to-vector.texinfo
 192 @include include/fun-sockets-vector-to-dotted.texinfo
 193 @include include/fun-sockets-colon-separated-to-vector.texinfo
 194 @include include/fun-sockets-vector-to-colon-separated.texinfo
 195 @include include/fun-sockets-string-address-to-vector.texinfo
 196 @include include/fun-sockets-map-ipv4-address-to-ipv6.texinfo
 197 @include include/fun-sockets-map-ipv6-address-to-ipv4.texinfo
 198
 199 @node DNS
 200 @section DNS
 201
 202 @subsection Functions
 203 @include include/fun-sockets-lookup-hostname.texinfo
 204 @include include/fun-sockets-ensure-hostname.texinfo
 205
 206 @subsection Conditions
 207 @include include/condition-sockets-resolver-error.texinfo
 208 @include include/fun-sockets-resolver-error-datum.texinfo
 209 @include include/condition-sockets-resolver-again-error.texinfo
 210 @include include/condition-sockets-resolver-fail-error.texinfo
 211 @include include/condition-sockets-resolver-no-name-error.texinfo
 212 @include include/condition-sockets-resolver-unknown-error.texinfo
 213
 214 @node Services
 215 @section Services
 216
 217 @include include/fun-sockets-lookup-service.texinfo
 218 @include include/condition-sockets-unknown-service.texinfo
 219 @include include/fun-sockets-unknown-service-datum.texinfo
 220
 221 @node Protocols
 222 @section Protocols
 223
 224 @include include/fun-sockets-lookup-protocol.texinfo
 225 @include include/condition-sockets-unknown-protocol.texinfo
 226 @include include/fun-sockets-unknown-protocol-datum.texinfo
 227
 228 @node Network Interfaces
 229 @section Network Interfaces
 230
 231 @include include/fun-sockets-interface-index.texinfo
 232 @include include/fun-sockets-interface-name.texinfo
 233 @include include/fun-sockets-make-interface.texinfo
 234 @include include/fun-sockets-lookup-interface.texinfo
 235 @include include/fun-sockets-list-network-interfaces.texinfo
 236 @include include/condition-sockets-unknown-interface.texinfo
 237 @include include/fun-sockets-unknown-interface-datum.texinfo