diff options
author | Seonah Moon <seonah1.moon@samsung.com> | 2020-12-15 19:56:19 +0900 |
---|---|---|
committer | Seonah Moon <seonah1.moon@samsung.com> | 2020-12-15 19:58:58 +0900 |
commit | bff27be9aa171a5afc25df79cd652337aa1ecbb0 (patch) | |
tree | bdfd96ad0138ccded52d4194d101dcc3eb7d959b /ares_getsock.3 | |
parent | 8e609b5f488d486a9e066ed494218d966f489938 (diff) | |
download | c-ares-bff27be9aa171a5afc25df79cd652337aa1ecbb0.tar.gz c-ares-bff27be9aa171a5afc25df79cd652337aa1ecbb0.tar.bz2 c-ares-bff27be9aa171a5afc25df79cd652337aa1ecbb0.zip |
Imported Upstream version 1.17.1upstream/1.17.1
Change-Id: Ifb18ec521bbeaf8bac560e0588657f136ca93e5d
Diffstat (limited to 'ares_getsock.3')
-rw-r--r-- | ares_getsock.3 | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/ares_getsock.3 b/ares_getsock.3 deleted file mode 100644 index 1373291..0000000 --- a/ares_getsock.3 +++ /dev/null @@ -1,57 +0,0 @@ -.\" -.\" Copyright 1998 by Daniel Stenberg -.\" -.\" Permission to use, copy, modify, and distribute this -.\" software and its documentation for any purpose and without -.\" fee is hereby granted, provided that the above copyright -.\" notice appear in all copies and that both that copyright -.\" notice and this permission notice appear in supporting -.\" documentation, and that the name of M.I.T. not be used in -.\" advertising or publicity pertaining to distribution of the -.\" software without specific, written prior permission. -.\" M.I.T. makes no representations about the suitability of -.\" this software for any purpose. It is provided "as is" -.\" without express or implied warranty. -.\" -.TH ARES_GETSOCK 3 "11 March 2010" -.SH NAME -ares_getsock \- get socket descriptors to wait on -.SH SYNOPSIS -.nf -.B #include <ares.h> -.PP -.B int ares_getsock(ares_channel \fIchannel\fP, ares_socket_t *\fIsocks\fP, -.B int \fInumsocks\fP); -.fi -.SH DESCRIPTION -The -.B ares_getsock -function retrieves the set of socket descriptors which the calling -application should wait on for reading and/or writing for the -processing of name service queries pending on the name service channel -identified by -.IR channel . -Socket descriptors will be set in the socket descriptor array pointed to by -\fIsocks\fP. -\fInumsocks\fP is the size of the given array in number of ints. - -This function can only return information about up to 16 sockets. If more are -in use (however unlikely that is), they are simply not reported back. -.SH RETURN VALUES -\fBares_getsock\fP returns a bitmask for what actions to wait for on the -different sockets. The ares.h header file provides these convenience macros to -extract the information appropriately: - -.nf -#define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about - this many sockets */ -#define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num))) -#define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \ - ARES_GETSOCK_MAXNUM))) -.fi -.SH NOTES -This function was added in c-ares 1.3.1 -.SH SEE ALSO -.BR ares_timeout (3), -.BR ares_fds (3), -.BR ares_process (3) |