ObjFW  Check-in [fbfe80e8fa]

Overview
Comment:Minor documentation fixes
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: fbfe80e8fa01e8755bd9b97469ace8d2fbdb3ab230528872dd2e30aa70bc1f9f
User & Date: js on 2018-08-14 00:26:52
Other Links: manifest | tags
Context
2018-08-15
00:21
OFDNSResolver: Try all search domains check-in: fcbb1100da user: js tags: trunk
2018-08-14
00:26
Minor documentation fixes check-in: fbfe80e8fa user: js tags: trunk
2018-08-13
21:53
OFDNSResolver: Let the buffer belong to the query check-in: 1e6bb58863 user: js tags: trunk
Changes

Modified src/OFDNSResolver.h from [5f0f9a4d52] to [f06d637d29].

158
159
160
161
162
163
164



165
166

167

168
169


170
171
172
173
174
175
176
177
178
179
180
181

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196



197
198

199

200
201


202
203
204
205
206
207
208
209
210
211
212
213

214
215
216
217
218
219
220

/*!
 * @brief Asynchronously resolves the specified host.
 *
 * @param host The host to resolve
 * @param target The target to call with the result once resolving is done
 * @param selector The selector to call on the target. The signature must be



 *		   `void (OFDNSResolver *resolver, OFString *domainName,
 *		   nullable OFArray<OFDNSResourceRecord *> *answerRecords,

 *		   nullable OFArray<OFDNSResourceRecord *> *authorityRecords,

 *		   nullable OFArray<OFDNSResourceRecord *> *additionalRecords,
 *		   nullable id context, nullable id exception)`.@n


 *		   `resolver` is the acting resolver.@n
 *		   `domainName` is the fully qualified domain name used to
 *		   resolve the host.@n
 *		   `answerRecords` are the answer records from the name server.
 *		   @n
 *		   `authorityRecords` are the authority records from the name
 *		   server.@n
 *		   `additionalRecords` are additional records sent by the name
 *		   server.
 *		   `context` is the context object originally passed.@n
 *		   `exception` is an exception that happened during resolving,
 *		   otherwise nil.

 * @param context A context object to pass along to the target
 */
- (void)asyncResolveHost: (OFString *)host
		  target: (id)target
		selector: (SEL)selector
		 context: (nullable id)context;

/*!
 * @brief Asynchronously resolves the specified host.
 *
 * @param host The host to resolve
 * @param recordClass The desired class of the records to query
 * @param recordType The desired type of the records to query
 * @param target The target to call with the result once resolving is done
 * @param selector The selector to call on the target. The signature must be



 *		   `void (OFDNSResolver *resolver, OFString *domainName,
 *		   nullable OFArray<OFDNSResourceRecord *> *answerRecords,

 *		   nullable OFArray<OFDNSResourceRecord *> *authorityRecords,

 *		   nullable OFArray<OFDNSResourceRecord *> *additionalRecords,
 *		   nullable id context, nullable id exception)`.@n


 *		   `resolver` is the acting resolver.@n
 *		   `domainName` is the fully qualified domain name used to
 *		   resolve the host.@n
 *		   `answerRecords` are the answer records from the name server.
 *		   @n
 *		   `authorityRecords` are the authority records from the name
 *		   server.@n
 *		   `additionalRecords` are additional records sent by the name
 *		   server.
 *		   `context` is the context object originally passed.@n
 *		   `exception` is an exception that happened during resolving,
 *		   otherwise nil.

 * @param context A context object to pass along to the target
 */
- (void)asyncResolveHost: (OFString *)host
	     recordClass: (of_dns_resource_record_class_t)recordClass
	      recordType: (of_dns_resource_record_type_t)recordType
		  target: (id)target
		selector: (SEL)selector







>
>
>
|
|
>
|
>
|
|
>
>








|



>















>
>
>
|
|
>
|
>
|
|
>
>








|



>







158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

/*!
 * @brief Asynchronously resolves the specified host.
 *
 * @param host The host to resolve
 * @param target The target to call with the result once resolving is done
 * @param selector The selector to call on the target. The signature must be
 *		   the following:
 *		   @parblock
 *
 *		       void (OFDNSResolver *resolver, OFString *domainName,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable answerRecords,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable authorityRecords,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable additionalRecords,
 *		           id _Nullable context, id _Nullable exception)
 *
 *		   `resolver` is the acting resolver.@n
 *		   `domainName` is the fully qualified domain name used to
 *		   resolve the host.@n
 *		   `answerRecords` are the answer records from the name server.
 *		   @n
 *		   `authorityRecords` are the authority records from the name
 *		   server.@n
 *		   `additionalRecords` are additional records sent by the name
 *		   server.@n
 *		   `context` is the context object originally passed.@n
 *		   `exception` is an exception that happened during resolving,
 *		   otherwise nil.
 *		   @endparblock
 * @param context A context object to pass along to the target
 */
- (void)asyncResolveHost: (OFString *)host
		  target: (id)target
		selector: (SEL)selector
		 context: (nullable id)context;

/*!
 * @brief Asynchronously resolves the specified host.
 *
 * @param host The host to resolve
 * @param recordClass The desired class of the records to query
 * @param recordType The desired type of the records to query
 * @param target The target to call with the result once resolving is done
 * @param selector The selector to call on the target. The signature must be
 *		   the following:
 *		   @parblock
 *
 *		       void (OFDNSResolver *resolver, OFString *domainName,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable answerRecords,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable authorityRecords,
 *		           OFArray<__kindof OFDNSResourceRecord *>
 *		           *_Nullable additionalRecords,
 *		           id _Nullable context, id _Nullable exception)
 *
 *		   `resolver` is the acting resolver.@n
 *		   `domainName` is the fully qualified domain name used to
 *		   resolve the host.@n
 *		   `answerRecords` are the answer records from the name server.
 *		   @n
 *		   `authorityRecords` are the authority records from the name
 *		   server.@n
 *		   `additionalRecords` are additional records sent by the name
 *		   server.@n
 *		   `context` is the context object originally passed.@n
 *		   `exception` is an exception that happened during resolving,
 *		   otherwise nil.
 *		   @endparblock
 * @param context A context object to pass along to the target
 */
- (void)asyncResolveHost: (OFString *)host
	     recordClass: (of_dns_resource_record_class_t)recordClass
	      recordType: (of_dns_resource_record_type_t)recordType
		  target: (id)target
		selector: (SEL)selector

Modified src/socket.h from [0b7ecc62d1] to [acbe13b260].

76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#endif

#ifdef OF_WII
typedef u8 sa_family_t;
#endif

/*!
 * @enum of_socket_address_type_t socket.h ObjFW/socket.h
 */
typedef enum {
	OF_SOCKET_ADDRESS_FAMILY_UNKNOWN,
	OF_SOCKET_ADDRESS_FAMILY_IPV4,
	OF_SOCKET_ADDRESS_FAMILY_IPV6,
} of_socket_address_family_t;








|







76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
#endif

#ifdef OF_WII
typedef u8 sa_family_t;
#endif

/*!
 * @brief A socket address family.
 */
typedef enum {
	OF_SOCKET_ADDRESS_FAMILY_UNKNOWN,
	OF_SOCKET_ADDRESS_FAMILY_IPV4,
	OF_SOCKET_ADDRESS_FAMILY_IPV6,
} of_socket_address_family_t;