Debian Codegraph @

upstream/debian-unstable/man3/Net::protoent.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Net::protoent 3perl"
58 .TH Net::protoent 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Net::protoent \- by\-name interface to Perl's built\-in getproto*() functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 4
68 \& use Net::protoent;
69 \& my $p = getprotobyname(shift || \*(Aqtcp\*(Aq) || die "no proto";
70 \& printf "proto for %s is %d, aliases are %s\en",
71 \& $p\->name, $p\->proto, "@{$p\->aliases}";
72 \&
73 \& use Net::protoent qw(:FIELDS);
74 \& getprotobyname(shift || \*(Aqtcp\*(Aq) || die "no proto";
75 \& print "proto for $p_name is $p_proto, aliases are @p_aliases\en";
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This module's default exports override the core \fBgetprotoent()\fR,
80 \&\fBgetprotobyname()\fR, and \fBgetnetbyport()\fR functions, replacing them with
81 versions that return "Net::protoent" objects. They take default
82 second arguments of "tcp". This object has methods that return the
83 similarly named structure field name from the C's protoent structure
84 from \fInetdb.h\fR; namely name, aliases, and proto. The aliases method
85 returns an array reference, the rest scalars.
86 .PP
87 You may also import all the structure fields directly into your namespace
88 as regular variables using the :FIELDS import tag. (Note that this still
89 overrides your core functions.) Access these fields as variables named
90 with a preceding \f(CW\*(C`p_\*(C'\fR. Thus, \f(CW\*(C`$proto_obj\->name()\*(C'\fR corresponds to
91 \&\f(CW$p_name\fR if you import the fields. Array references are available as
92 regular array variables, so for example \f(CW\*(C`@{ $proto_obj\->aliases()
93 }\*(C'\fR would be simply \f(CW@p_aliases\fR.
94 .PP
95 The \fBgetproto()\fR function is a simple front-end that forwards a numeric
96 argument to \fBgetprotobyport()\fR, and the rest to \fBgetprotobyname()\fR.
97 .PP
98 To access this functionality without the core overrides,
99 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
100 function functions with their full qualified names.
101 On the other hand, the built-ins are still available
102 via the \f(CW\*(C`CORE::\*(C'\fR pseudo-package.
103 .SH NOTE
104 .IX Header "NOTE"
105 While this class is currently implemented using the Class::Struct
106 module to build a struct-like class, you shouldn't rely upon this.
107 .SH AUTHOR
108 .IX Header "AUTHOR"
109 Tom Christiansen