lib/libc/net/getprotoent.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getprotoent.3       8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/net/getprotoent.3,v 1.12 2007/01/09 00:28:02 imp Exp $
  30 .\"
  31 .Dd May 4, 2019
  32 .Dt GETPROTOENT 3
  33 .Os
  34 .Sh NAME
  35 .Nm getprotoent ,
  36 .Nm getprotoent_r ,
  37 .Nm getprotobynumber ,
  38 .Nm getprotobynumber_r ,
  39 .Nm getprotobyname ,
  40 .Nm getprotobyname_r ,
  41 .Nm setprotoent ,
  42 .Nm endprotoent
  43 .Nd get protocol entry
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In netdb.h
  48 .Ft struct protoent *
  49 .Fn getprotoent void
  50 .Ft int
  51 .Fn getprotoent_r "struct protoent *" "char *" "size_t" "struct protoent **"
  52 .Ft struct protoent *
  53 .Fn getprotobyname "const char *name"
  54 .Ft int
  55 .Fn getprotobyname_r "const char *" "struct protoent *" "char *" "size_t" "struct protoent **"
  56 .Ft struct protoent *
  57 .Fn getprotobynumber "int proto"
  58 .Ft int
  59 .Fn getprotobynumber_r "int" "struct protoent *" "char *" "size_t" "struct protoent **"
  60 .Ft void
  61 .Fn setprotoent "int stayopen"
  62 .Ft void
  63 .Fn endprotoent void
  64 .Sh DESCRIPTION
  65 The
  66 .Fn getprotoent ,
  67 .Fn getprotobyname ,
  68 and
  69 .Fn getprotobynumber
  70 functions
  71 each return a pointer to an object with the
  72 following structure
  73 containing the broken-out
  74 fields of a line in the network protocol data base,
  75 .Pa /etc/protocols .
  76 .Bd -literal -offset indent
  77 struct  protoent {
  78         char    *p_name;        /* official name of protocol */
  79         char    **p_aliases;    /* alias list */
  80         int     p_proto;        /* protocol number */
  81 };
  82 .Ed
  83 .Pp
  84 The members of this structure are:
  85 .Bl -tag -width p_aliases
  86 .It Fa p_name
  87 The official name of the protocol.
  88 .It Fa p_aliases
  89 A zero terminated list of alternate names for the protocol.
  90 .It Fa p_proto
  91 The protocol number.
  92 .El
  93 .Pp
  94 The
  95 .Fn getprotoent
  96 function
  97 reads the next line of the file, opening the file if necessary.
  98 .Pp
  99 The
 100 .Fn setprotoent
 101 function
 102 opens and rewinds the file.
 103 If the
 104 .Fa stayopen
 105 flag is non-zero,
 106 the net data base will not be closed after each call to
 107 .Fn getprotobyname
 108 or
 109 .Fn getprotobynumber .
 110 .Pp
 111 The
 112 .Fn endprotoent
 113 function
 114 closes the file.
 115 .Pp
 116 The
 117 .Fn getprotobyname
 118 function
 119 and
 120 .Fn getprotobynumber
 121 sequentially search from the beginning
 122 of the file until a matching
 123 protocol name or
 124 protocol number is found,
 125 or until
 126 .Dv EOF
 127 is encountered.
 128 .Pp
 129 The
 130 .Fn getprotoent_r ,
 131 .Fn getprotobynumber_r ,
 132 and
 133 .Fn getprotobyname_r
 134 functions are reentrant versions of the above functions that take a
 135 pointer to a
 136 .Vt protoent
 137 structure which is used to store state information.
 138 The structure must be zero-filled before it is used
 139 and should be considered opaque for the sake of portability.
 140 These functions also take a pointer to another
 141 .Vt protoent
 142 structure which is used to store the results of the database lookup.
 143 .Sh RETURN VALUES
 144 The
 145 .Fn getprotoent ,
 146 .Fn getprotobynumber ,
 147 and
 148 .Fn getprotobyname
 149 functions return a pointer to a
 150 .Vt protoent
 151 structure on success or a null pointer if end-of-file
 152 is reached or an error occurs.
 153 .Pp
 154 The
 155 .Fn getprotoent_r ,
 156 .Fn getprotobynumber_r ,
 157 and
 158 .Fn getprotobyname_r
 159 functions return 0 on success or \-1 if end-of-file
 160 is reached or an error occurs.
 161 .Sh FILES
 162 .Bl -tag -width ".Pa /etc/protocols" -compact
 163 .It Pa /etc/protocols
 164 .El
 165 .Sh SEE ALSO
 166 .Xr protocols 5
 167 .Sh STANDARDS
 168 The
 169 .Fn getprotoent ,
 170 .Fn getprotobynumber ,
 171 .Fn getprotobyname ,
 172 .Fn setprotoent ,
 173 and
 174 .Fn endprotoent
 175 functions conform to
 176 .St -p1003.1-2004 .
 177 .Pp
 178 The
 179 .Fn getprotoent_r ,
 180 .Fn getprotobynumber_r ,
 181 and
 182 .Fn getprotobyname_r
 183 functions are not currently standardized.
 184 .Sh HISTORY
 185 The
 186 .Fn getprotoent ,
 187 .Fn getprotobynumber ,
 188 .Fn getprotobyname ,
 189 .Fn setprotoent ,
 190 and
 191 .Fn endprotoent
 192 functions appeared in
 193 .Bx 4.2 .
 194 .Pp
 195 The
 196 .Fn getprotoent_r ,
 197 .Fn getprotobynumber_r ,
 198 and
 199 .Fn getprotobyname_r
 200 functions appeared in
 201 .Dx 2.1 .
 202 .Sh BUGS
 203 These functions use a thread-specific data space;
 204 if the data is needed for future use, it should be
 205 copied before any subsequent calls overwrite it.
 206 Only the Internet
 207 protocols are currently understood.