doc/sockets.texinfo

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