1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)getservent.3 8.3 (Berkeley) 1/12/94
29 .\" $FreeBSD: src/lib/libc/net/getservent.3,v 1.15 2007/01/09 00:28:02 imp Exp $
51 .Fn getservent_r "struct servent *" "char *" "size_t" "struct servent **"
53 .Fn getservbyname "const char *name" "const char *proto"
55 .Fn getservbyname_r "const char *" "const char *" "struct servent *" "char *" "size_t" "struct servent **"
57 .Fn getservbyport "int port" "const char *proto"
59 .Fn getservbyport_r "int" "const char *" "struct servent *" "char *" "size_t" "struct servent **"
61 .Fn setservent "int stayopen"
71 each return a pointer to an object with the
73 containing the broken-out
74 fields of a line in the network services data base,
76 .Bd -literal -offset indent
78 char *s_name; /* official name of service */
79 char **s_aliases; /* alias list */
80 int s_port; /* port service resides at */
81 char *s_proto; /* protocol to use */
85 The members of this structure are:
86 .Bl -tag -width s_aliases
88 The official name of the service.
90 A zero terminated list of alternate names for the service.
92 The port number at which the service resides.
93 Port numbers are returned in network byte order.
95 The name of the protocol to use when contacting the
102 reads the next line of the file, opening the file if necessary.
107 opens and rewinds the file.
111 the net data base will not be closed after each call to
126 sequentially search from the beginning
127 of the file until a matching
129 port number (which must be specified in
130 network byte order) is found,
134 If a protocol name is also supplied (non-
136 searches must also match the protocol.
140 .Fn getservbyport_r ,
143 functions are reentrant versions of the above functions that take a
146 structure which is used to store state information.
147 The structure must be zero-filled before it is used
148 and should be considered opaque for the sake of portability.
149 These functions also take a pointer to another
151 structure which is used to store the results of the database lookup.
158 functions return a pointer to a
160 structure on success or a null pointer if end-of-file
161 is reached or an error occurs.
165 .Fn getservbyport_r ,
168 functions return 0 on success or \-1 if end-of-file
169 is reached or an error occurs.
171 .Bl -tag -width ".Pa /etc/services" -compact
180 .Fn getservbynumber ,
190 .Fn getservbyport_r ,
193 functions are not currently standardized.
202 functions appeared in
207 .Fn getservbyport_r ,
210 functions appeared in
213 These functions use a thread-specific data storage;
214 if the data is needed for future use, it should be
215 copied before any subsequent calls overwrite it.
216 Expecting port numbers to fit in a 32 bit
217 quantity is probably naive.