Major changes in the way socket options work.
[iolib.git] / doc / sockets.texinfo
blob800b0563037833ec55a0f7f320fd5ce1ee7ea237
1 @menu
2 * Overview::                    
3 * Socket Addresses::            
4 * Name Service::                
5 * Services::                    
6 * Protocols::                   
7 * Network Interfaces::          
8 * Sockets::                     
9 * Comprehensive Index::         
10 @end menu
12 @node Sockets Overview
13 @section Overview
15 Describe sockets here.
17 @node Socket Addresses
18 @section Socket Addresses
20 @menu
21 * Address Objects::             
22 * Sockets Address Predicates::  
23 * Sockets Low-level Address Manipulation::  
24 @end menu
26 @node Address Objects
27 @subsection Address Objects
29 @subsubsection Classes
31 @include include/class-sockets-address.texinfo
32 @include include/class-sockets-inet-address.texinfo
33 @include include/class-sockets-ipv4-address.texinfo
34 @include include/class-sockets-ipv6-address.texinfo
35 @include include/class-sockets-local-address.texinfo
37 @subsubsection Functions and Methods
39 @include include/fun-sockets-make-address.texinfo
40 @include include/fun-sockets-address-to-string.texinfo
41 @include include/fun-sockets-address-to-vector.texinfo
42 @include include/fun-sockets-copy-address.texinfo
43 @include include/fun-sockets-ensure-address.texinfo
45 @subsubsection Constants
47 @include include/constant-sockets-plus-ipv4-loopback-plus.texinfo
48 @include include/constant-sockets-plus-ipv4-unspecified-plus.texinfo
49 @include include/constant-sockets-plus-ipv6-interface-local-all-nodes-plus.texinfo
50 @include include/constant-sockets-plus-ipv6-interface-local-all-routers-plus.texinfo
51 @include include/constant-sockets-plus-ipv6-link-local-all-nodes-plus.texinfo
52 @include include/constant-sockets-plus-ipv6-link-local-all-routers-plus.texinfo
53 @include include/constant-sockets-plus-ipv6-loopback-plus.texinfo
54 @include include/constant-sockets-plus-ipv6-site-local-all-routers-plus.texinfo
55 @include include/constant-sockets-plus-ipv6-unspecified-plus.texinfo
57 @node Sockets Address Predicates
58 @subsection Address Predicates
60 @include include/fun-sockets-address-equal-p.texinfo
61 @include include/fun-sockets-addressp.texinfo
62 @include include/fun-sockets-address-type.texinfo
63 @include include/fun-sockets-address=.texinfo
64 @include include/fun-sockets-inet-address-loopback-p.texinfo
65 @include include/fun-sockets-inet-address-multicast-p.texinfo
66 @include include/fun-sockets-inet-address-type.texinfo
67 @include include/fun-sockets-inet-address-unicast-p.texinfo
68 @include include/fun-sockets-inet-address-unspecified-p.texinfo
69 @include include/fun-sockets-ipv4-address-p.texinfo
70 @include include/fun-sockets-ipv6-address-p.texinfo
71 @include include/fun-sockets-ipv6-admin-local-multicast-p.texinfo
72 @include include/fun-sockets-ipv6-global-multicast-p.texinfo
73 @include include/fun-sockets-ipv6-global-unicast-p.texinfo
74 @include include/fun-sockets-ipv6-interface-local-multicast-p.texinfo
75 @include include/fun-sockets-ipv6-ipv4-mapped-p.texinfo
76 @include include/fun-sockets-ipv6-link-local-multicast-p.texinfo
77 @include include/fun-sockets-ipv6-link-local-unicast-p.texinfo
78 @include include/fun-sockets-ipv6-multicast-type.texinfo
79 @include include/fun-sockets-ipv6-organization-local-multicast-p.texinfo
80 @include include/fun-sockets-ipv6-reserved-multicast-p.texinfo
81 @include include/fun-sockets-ipv6-site-local-multicast-p.texinfo
82 @include include/fun-sockets-ipv6-site-local-unicast-p.texinfo
83 @include include/fun-sockets-ipv6-solicited-node-multicast-p.texinfo
84 @include include/fun-sockets-ipv6-transient-multicast-p.texinfo
85 @include include/fun-sockets-ipv6-unassigned-multicast-p.texinfo
86 @include include/fun-sockets-ipv6-unicast-type.texinfo
87 @include include/fun-sockets-local-address-p.texinfo
89 @node Sockets Low-level Address Manipulation
90 @subsection Low-level Address Manipulation
92 @include include/constant-sockets-plus-max-ipv4-value-plus.texinfo
93 @include include/fun-sockets-integer-to-dotted.texinfo
94 @include include/fun-sockets-colon-separated-to-vector.texinfo
95 @include include/fun-sockets-string-address-to-vector.texinfo
96 @include include/fun-sockets-vector-to-colon-separated.texinfo
97 @include include/fun-sockets-vector-to-dotted.texinfo
98 @include include/fun-sockets-dotted-to-integer.texinfo
99 @include include/fun-sockets-dotted-to-vector.texinfo
101 @node Sockets Name Service
102 @section Name Service
104 @subsection Conditions
105 @include include/condition-sockets-resolver-again-error.texinfo
106 @include include/condition-sockets-resolver-error.texinfo
107 @include include/condition-sockets-resolver-fail-error.texinfo
108 @include include/condition-sockets-resolver-no-name-error.texinfo
109 @include include/condition-sockets-resolver-no-service-error.texinfo
110 @include include/condition-sockets-resolver-unknown-error.texinfo
112 @subsection Classes and Functions
113 @include include/class-sockets-host.texinfo
114 @include include/fun-sockets-lookup-host.texinfo
115 @include include/fun-sockets-convert-or-lookup-inet-address.texinfo
117 @node Socket Services
118 @section Services
120 @include include/class-sockets-service.texinfo
121 @include include/fun-sockets-make-service.texinfo
122 @include include/fun-sockets-lookup-service.texinfo
124 @node Socket Protocols
125 @section Protocols
127 @include include/class-sockets-protocol.texinfo
128 @include include/fun-sockets-make-protocol.texinfo
129 @include include/condition-sockets-unknown-protocol.texinfo
130 @include include/fun-sockets-lookup-protocol.texinfo
132 @node socket Network Interfaces
133 @section Network Interfaces
135 @include include/class-sockets-interface.texinfo
136 @include include/condition-sockets-unknown-interface.texinfo
137 @include include/fun-sockets-make-interface.texinfo
138 @include include/fun-sockets-lookup-interface.texinfo
139 @include include/fun-sockets-list-network-interfaces.texinfo
141 @node Sockets
142 @section Sockets
144 @menu
145 * Socket Classes::              
146 * Socket Options::              
147 * Socket Methods::              
148 @end menu
150 @node Socket Classes
151 @subsection Socket Classes
153 @subsubsection INET Domain Sockets
154 @subsubsection Local Domain Sockets
156 @node Socket Options
157 @subsection Socket Options
159 @node Socket Methods
160 @subsection Socket Methods