logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

netdb.h.0p (9452B)

    

  1. '\" et
  2. .TH netdb.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. netdb.h
  12. \(em definitions for network database operations
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <netdb.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <netdb.h> 
  21. header may define the
  22. .BR in_port_t
  23. type and the
  24. .BR in_addr_t
  25. type as described in
  26. .IR <netinet/in.h> .
  27. .P
  28. The
  29. .IR <netdb.h> 
  30. header shall define the
  31. .BR hostent
  32. structure, which shall include at least the following members:
  33. .sp
  34. .RS 4
  35. .nf
  37. char   *h_name       \fROfficial name of the host.\fR
  38. char  **h_aliases    \fRA pointer to an array of pointers to\fR
  39.                      \fRalternative host names, terminated by a\fR
  40.                      \fRnull pointer.\fR
  41. int     h_addrtype   \fRAddress type.\fR
  42. int     h_length     \fRThe length, in bytes, of the address.\fR
  43. char  **h_addr_list  \fRA pointer to an array of pointers to network\fR
  44.                      \fRaddresses (in network byte order) for the host,\fR
  45.                      \fRterminated by a null pointer.\fR
  46. .fi
  47. .P
  48. .RE
  49. .P
  50. The
  51. .IR <netdb.h> 
  52. header shall define the
  53. .BR netent
  54. structure, which shall include at least the following members:
  55. .sp
  56. .RS 4
  57. .nf
  59. char     *n_name      \fROfficial, fully-qualified (including the\fR
  60.                       \fRdomain) name of the host.\fR
  61. char    **n_aliases   \fRA pointer to an array of pointers to\fR
  62.                       \fRalternative network names, terminated by a\fR
  63.                       \fRnull pointer.\fR
  64. int       n_addrtype  \fRThe address type of the network.\fR
  65. uint32_t  n_net       \fRThe network number, in host byte order.\fR
  66. .fi
  67. .P
  68. .RE
  69. .P
  70. The
  71. .IR <netdb.h> 
  72. header shall define the
  73. .BR uint32_t
  74. type as described in
  75. .IR <inttypes.h> .
  76. .P
  77. The
  78. .IR <netdb.h> 
  79. header shall define the
  80. .BR protoent
  81. structure, which shall include at least the following members:
  82. .sp
  83. .RS 4
  84. .nf
  86. char   *p_name     \fROfficial name of the protocol.\fR
  87. char  **p_aliases  \fRA pointer to an array of pointers to\fR
  88.                    \fRalternative protocol names, terminated by\fR
  89.                    \fRa null pointer.\fR
  90. int     p_proto    \fRThe protocol number.\fR
  91. .fi
  92. .P
  93. .RE
  94. .P
  95. The
  96. .IR <netdb.h> 
  97. header shall define the
  98. .BR servent
  99. structure, which shall include at least the following members:
  100. .sp
  101. .RS 4
  102. .nf
  104. char   *s_name     \fROfficial name of the service.\fR
  105. char  **s_aliases  \fRA pointer to an array of pointers to\fR
  106.                    \fRalternative service names, terminated by\fR
  107.                    \fRa null pointer.\fR
  108. int     s_port     \fRA value which, when converted to uint16_t,\fR
  109.                    \fRyields the port number in network byte order\fR
  110.                    \fRat which the service resides.\fR
  111. char   *s_proto    \fRThe name of the protocol to use when\fR
  112.                    \fRcontacting the service.\fR
  113. .fi
  114. .P
  115. .RE
  116. .P
  117. The
  118. .IR <netdb.h> 
  119. header shall define the IPPORT_RESERVED symbolic constant with the
  120. value of the highest reserved Internet port number.
  121. .SS "Address Information Structure"
  122. .P
  123. The
  124. .IR <netdb.h> 
  125. header shall define the
  126. .BR addrinfo
  127. structure, which shall include at least the following members:
  128. .sp
  129. .RS 4
  130. .nf
  132. int               ai_flags      \fRInput flags.\fR
  133. int               ai_family     \fRAddress family of socket.\fR
  134. int               ai_socktype   \fRSocket type.\fR
  135. int               ai_protocol   \fRProtocol of socket.\fR
  136. socklen_t         ai_addrlen    \fRLength of socket address.\fR
  137. struct sockaddr  *ai_addr       \fRSocket address of socket.\fR
  138. char             *ai_canonname  \fRCanonical name of service location.\fR
  139. struct addrinfo  *ai_next       \fRPointer to next in list.\fR
  140. .fi
  141. .P
  142. .RE
  143. .P
  144. The
  145. .IR <netdb.h> 
  146. header shall define the following symbolic constants that evaluate to
  147. bitwise-distinct integer constants for use in the
  148. .IR flags
  149. field of the
  150. .BR addrinfo
  151. structure:
  152. .IP AI_PASSIVE 14
  153. Socket address is intended for
  154. \fIbind\fR().
  155. .IP AI_CANONNAME 14
  156. Request for canonical name.
  157. .IP AI_NUMERICHOST 14
  158. Return numeric host address as name.
  159. .IP AI_NUMERICSERV 14
  160. Inhibit service name resolution.
  161. .IP AI_V4MAPPED 14
  162. If no IPv6 addresses are found, query for IPv4 addresses and return
  163. them to the caller as IPv4-mapped IPv6 addresses.
  164. .IP AI_ALL 14
  165. Query for both IPv4 and IPv6 addresses.
  166. .IP AI_ADDRCONFIG 14
  167. Query for IPv4 addresses only when an IPv4 address is configured;
  168. query for IPv6 addresses only when an IPv6 address is configured.
  169. .P
  170. The
  171. .IR <netdb.h> 
  172. header shall define the following symbolic constants that evaluate
  173. to bitwise-distinct integer constants for use in the
  174. .IR flags
  175. argument to
  176. \fIgetnameinfo\fR():
  177. .IP NI_NOFQDN 14
  178. Only the nodename portion of the FQDN is returned for local hosts.
  179. .IP NI_NUMERICHOST 14
  180. The numeric form of the node's address is returned instead of its
  181. name.
  182. .IP NI_NAMEREQD 14
  183. Return an error if the node's name cannot be located in the database.
  184. .IP NI_NUMERICSERV 14
  185. The numeric form of the service address is returned instead of its name.
  186. .IP NI_NUMERICSCOPE 14
  187. .br
  188. For IPv6 addresses, the numeric form of the scope identifier is
  189. returned instead of its name.
  190. .IP NI_DGRAM 14
  191. Indicates that the service is a datagram service (SOCK_DGRAM).
  192. .SS "Address Information Errors"
  193. .P
  194. The
  195. .IR <netdb.h> 
  196. header shall define the following symbolic constants for use as
  197. error values for
  198. \fIgetaddrinfo\fR()
  199. and
  200. \fIgetnameinfo\fR().
  201. The values shall be suitable for use in
  202. .BR #if
  203. preprocessing directives.
  204. .IP EAI_AGAIN 14
  205. The name could not be resolved at this time. Future attempts may
  206. succeed.
  207. .IP EAI_BADFLAGS 14
  208. The flags had an invalid value.
  209. .IP EAI_FAIL 14
  210. A non-recoverable error occurred.
  211. .IP EAI_FAMILY 14
  212. The address family was not recognized or the address length was invalid
  213. for the specified family.
  214. .IP EAI_MEMORY 14
  215. There was a memory allocation failure.
  216. .IP EAI_NONAME 14
  217. The name does not resolve for the supplied parameters.
  218. .RS 14 
  219. .P
  220. NI_NAMEREQD is set and the host's name cannot be located, or both
  221. .IR nodename
  222. and
  223. .IR servname
  224. were null.
  225. .RE
  226. .IP EAI_SERVICE 14
  227. The service passed was not recognized for the specified socket type.
  228. .IP EAI_SOCKTYPE 14
  229. The intended socket type was not recognized.
  230. .IP EAI_SYSTEM 14
  231. A system error occurred. The error code can be found in
  232. .IR errno .
  233. .IP EAI_OVERFLOW 14
  234. An argument buffer overflowed.
  235. .P
  236. The following shall be declared as functions and may also be defined as
  237. macros. Function prototypes shall be provided.
  238. .sp
  239. .RS 4
  240. .nf
  242. void              endhostent(void);
  243. void              endnetent(void);
  244. void              endprotoent(void);
  245. void              endservent(void);
  246. void              freeaddrinfo(struct addrinfo *);
  247. const char       *gai_strerror(int);
  248. int               getaddrinfo(const char *restrict, const char *restrict,
  249.                       const struct addrinfo *restrict,
  250.                       struct addrinfo **restrict);
  251. struct hostent   *gethostent(void);
  252. int               getnameinfo(const struct sockaddr *restrict, socklen_t,
  253.                       char *restrict, socklen_t, char *restrict,
  254.                       socklen_t, int);
  255. struct netent    *getnetbyaddr(uint32_t, int);
  256. struct netent    *getnetbyname(const char *);
  257. struct netent    *getnetent(void);
  258. struct protoent  *getprotobyname(const char *);
  259. struct protoent  *getprotobynumber(int);
  260. struct protoent  *getprotoent(void);
  261. struct servent   *getservbyname(const char *, const char *);
  262. struct servent   *getservbyport(int, const char *);
  263. struct servent   *getservent(void);
  264. void              sethostent(int);
  265. void              setnetent(int);
  266. void              setprotoent(int);
  267. void              setservent(int);
  268. .fi
  269. .P
  270. .RE
  271. .P
  272. The
  273. .IR <netdb.h> 
  274. header shall define the
  275. .BR socklen_t
  276. type through
  277. .BR typedef ,
  278. as described in
  279. .IR <sys/socket.h> .
  280. .P
  281. Inclusion of the
  282. .IR <netdb.h> 
  283. header may also make visible all symbols from
  284. .IR <netinet/in.h> ,
  285. .IR <sys/socket.h> ,
  286. and
  287. .IR <inttypes.h> .
  288. .LP
  289. .IR "The following sections are informative."
  290. .SH "APPLICATION USAGE"
  291. None.
  292. .SH "RATIONALE"
  293. None.
  294. .SH "FUTURE DIRECTIONS"
  295. None.
  296. .SH "SEE ALSO"
  297. .IR "\fB<inttypes.h>\fP",
  298. .IR "\fB<netinet_in.h>\fP",
  299. .IR "\fB<sys_socket.h>\fP"
  300. .P
  301. The System Interfaces volume of POSIX.1\(hy2017,
  302. .IR "\fIbind\fR\^(\|)",
  303. .IR "\fIendhostent\fR\^(\|)",
  304. .IR "\fIendnetent\fR\^(\|)",
  305. .IR "\fIendprotoent\fR\^(\|)",
  306. .IR "\fIendservent\fR\^(\|)",
  307. .IR "\fIfreeaddrinfo\fR\^(\|)",
  308. .IR "\fIgai_strerror\fR\^(\|)",
  309. .IR "\fIgetnameinfo\fR\^(\|)"
  310. .\"
  311. .SH COPYRIGHT
  312. Portions of this text are reprinted and reproduced in electronic form
  313. from IEEE Std 1003.1-2017, Standard for Information Technology
  314. -- Portable Operating System Interface (POSIX), The Open Group Base
  315. Specifications Issue 7, 2018 Edition,
  316. Copyright (C) 2018 by the Institute of
  317. Electrical and Electronics Engineers, Inc and The Open Group.
  318. In the event of any discrepancy between this version and the original IEEE and
  319. The Open Group Standard, the original IEEE and The Open Group Standard
  320. is the referee document. The original Standard can be obtained online at
  321. http://www.opengroup.org/unix/online.html .
  322. .PP
  323. Any typographical or formatting errors that appear
  324. in this page are most likely
  325. to have been introduced during the conversion of the source files to
  326. man page format. To report such errors, see
  327. https://www.kernel.org/doc/man-pages/reporting_bugs.html .