Update docs.
[iolib.git] / doc / sockets.texinfo
blob07ad451af2183b77474ae2b57134015257714dca
1 @menu
2 * Sockets Overview::
3 * Addresses::
4 * Name Service::
5 * Services::
6 * Protocols::
7 * Network Interfaces::
8 @c * Sockets::
9 @end menu
11 @node Sockets Overview
12 @section Overview
14 Describe sockets here.
16 @node Addresses
17 @section Socket Addresses
19 @menu
20 * Address Objects::
21 * Address Predicates::
22 * Low-level Address Manipulation::
23 @end menu
25 @node Address Objects
26 @subsection Address Objects
28 @subsubsection Classes
30 @include include/class-sockets-address.texinfo
31 @include include/class-sockets-inet-address.texinfo
32 @include include/class-sockets-ipv4-address.texinfo
33 @include include/class-sockets-ipv6-address.texinfo
34 @include include/class-sockets-local-address.texinfo
36 @subsubsection Functions and Methods
38 @include include/fun-sockets-make-address.texinfo
39 @include include/fun-sockets-address-to-string.texinfo
40 @include include/fun-sockets-address-to-vector.texinfo
41 @include include/fun-sockets-copy-address.texinfo
42 @include include/fun-sockets-ensure-address.texinfo
44 @subsubsection Constants
46 @include include/constant-sockets-plus-ipv4-loopback-plus.texinfo
47 @include include/constant-sockets-plus-ipv4-unspecified-plus.texinfo
48 @include include/constant-sockets-plus-ipv6-interface-local-all-nodes-plus.texinfo
49 @include include/constant-sockets-plus-ipv6-interface-local-all-routers-plus.texinfo
50 @include include/constant-sockets-plus-ipv6-link-local-all-nodes-plus.texinfo
51 @include include/constant-sockets-plus-ipv6-link-local-all-routers-plus.texinfo
52 @include include/constant-sockets-plus-ipv6-loopback-plus.texinfo
53 @include include/constant-sockets-plus-ipv6-site-local-all-routers-plus.texinfo
54 @include include/constant-sockets-plus-ipv6-unspecified-plus.texinfo
56 @node Address Predicates
57 @subsection Address Predicates
59 @include include/fun-sockets-address-equal-p.texinfo
60 @include include/fun-sockets-addressp.texinfo
61 @include include/fun-sockets-address-type.texinfo
62 @include include/fun-sockets-address=.texinfo
63 @include include/fun-sockets-inet-address-loopback-p.texinfo
64 @include include/fun-sockets-inet-address-multicast-p.texinfo
65 @include include/fun-sockets-inet-address-type.texinfo
66 @include include/fun-sockets-inet-address-unicast-p.texinfo
67 @include include/fun-sockets-inet-address-unspecified-p.texinfo
68 @include include/fun-sockets-ipv4-address-p.texinfo
69 @include include/fun-sockets-ipv6-address-p.texinfo
70 @include include/fun-sockets-ipv6-admin-local-multicast-p.texinfo
71 @include include/fun-sockets-ipv6-global-multicast-p.texinfo
72 @include include/fun-sockets-ipv6-global-unicast-p.texinfo
73 @include include/fun-sockets-ipv6-interface-local-multicast-p.texinfo
74 @include include/fun-sockets-ipv6-ipv4-mapped-p.texinfo
75 @include include/fun-sockets-ipv6-link-local-multicast-p.texinfo
76 @include include/fun-sockets-ipv6-link-local-unicast-p.texinfo
77 @include include/fun-sockets-ipv6-multicast-type.texinfo
78 @include include/fun-sockets-ipv6-organization-local-multicast-p.texinfo
79 @include include/fun-sockets-ipv6-reserved-multicast-p.texinfo
80 @include include/fun-sockets-ipv6-site-local-multicast-p.texinfo
81 @include include/fun-sockets-ipv6-site-local-unicast-p.texinfo
82 @include include/fun-sockets-ipv6-solicited-node-multicast-p.texinfo
83 @include include/fun-sockets-ipv6-transient-multicast-p.texinfo
84 @include include/fun-sockets-ipv6-unassigned-multicast-p.texinfo
85 @include include/fun-sockets-ipv6-unicast-type.texinfo
86 @include include/fun-sockets-local-address-p.texinfo
88 @node Low-level Address Manipulation
89 @subsection Low-level Address Manipulation
91 @include include/constant-sockets-plus-max-ipv4-value-plus.texinfo
92 @include include/fun-sockets-integer-to-dotted.texinfo
93 @include include/fun-sockets-colon-separated-to-vector.texinfo
94 @include include/fun-sockets-string-address-to-vector.texinfo
95 @include include/fun-sockets-vector-to-colon-separated.texinfo
96 @include include/fun-sockets-vector-to-dotted.texinfo
97 @include include/fun-sockets-dotted-to-integer.texinfo
98 @include include/fun-sockets-dotted-to-vector.texinfo
100 @node Name Service
101 @section Name Service
103 @subsection Functions
104 @include include/fun-sockets-lookup-host.texinfo
105 @include include/fun-sockets-ensure-hostname.texinfo
107 @subsection Conditions
108 @include include/condition-sockets-resolver-error.texinfo
109 @include include/condition-sockets-resolver-again-error.texinfo
110 @include include/condition-sockets-resolver-fail-error.texinfo
111 @include include/condition-sockets-resolver-no-name-error.texinfo
112 @include include/condition-sockets-resolver-unknown-error.texinfo
114 @node Services
115 @section Services
117 @include include/fun-sockets-lookup-service.texinfo
118 @include include/condition-sockets-unknown-service.texinfo
120 @node Protocols
121 @section Protocols
123 @include include/fun-sockets-lookup-protocol.texinfo
124 @include include/condition-sockets-unknown-protocol.texinfo
126 @node Network Interfaces
127 @section Network Interfaces
129 @include include/class-sockets-interface.texinfo
130 @include include/fun-sockets-make-interface.texinfo
131 @include include/fun-sockets-lookup-interface.texinfo
132 @include include/fun-sockets-list-network-interfaces.texinfo
133 @include include/condition-sockets-unknown-interface.texinfo
135 @c @node Sockets
136 @c @section Sockets
138 @c @menu
139 @c * Socket Classes::
140 @c * Socket Options::
141 @c * Socket Methods::
142 @c @end menu
144 @c @node Socket Classes
145 @c @subsection Socket Classes
147 @c @subsubsection INET Domain Sockets
148 @c @subsubsection Local Domain Sockets
150 @c @node Socket Options
151 @c @subsection Socket Options
153 @c @node Socket Methods
154 @c @subsection Socket Methods