Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Net::protoent.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Net::protoent 3pm"
61 .TH Net::protoent 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Net::protoent \- by\-name interface to Perl\*(Aqs built\-in getproto*() functions
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 4
71 \& use Net::protoent;
72 \& my $p = getprotobyname(shift || \*(Aqtcp\*(Aq) || die "no proto";
73 \& printf "proto for %s is %d, aliases are %s\en",
74 \& $p\->name, $p\->proto, "@{$p\->aliases}";
75 \&
76 \& use Net::protoent qw(:FIELDS);
77 \& getprotobyname(shift || \*(Aqtcp\*(Aq) || die "no proto";
78 \& print "proto for $p_name is $p_proto, aliases are @p_aliases\en";
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 This module\*(Aqs default exports override the core \fBgetprotoent()\fR,
83 \&\fBgetprotobyname()\fR, and \fBgetnetbyport()\fR functions, replacing them with
84 versions that return "Net::protoent" objects. They take default
85 second arguments of "tcp". This object has methods that return the
86 similarly named structure field name from the C\*(Aqs protoent structure
87 from \fInetdb.h\fR; namely name, aliases, and proto. The aliases method
88 returns an array reference, the rest scalars.
89 .PP
90 You may also import all the structure fields directly into your namespace
91 as regular variables using the :FIELDS import tag. (Note that this still
92 overrides your core functions.) Access these fields as variables named
93 with a preceding \f(CW\*(C`p_\*(C'\fR. Thus, \f(CW\*(C`$proto_obj\->name()\*(C'\fR corresponds to
94 \&\f(CW$p_name\fR if you import the fields. Array references are available as
95 regular array variables, so for example \f(CW\*(C`@{ $proto_obj\->aliases()
96 }\*(C'\fR would be simply \f(CW@p_aliases\fR.
97 .PP
98 The \fBgetproto()\fR function is a simple front\-end that forwards a numeric
99 argument to \fBgetprotobyport()\fR, and the rest to \fBgetprotobyname()\fR.
100 .PP
101 To access this functionality without the core overrides,
102 pass the \f(CW\*(C`use\*(C'\fR an empty import list, and then access
103 function functions with their full qualified names.
104 On the other hand, the built\-ins are still available
105 via the \f(CW\*(C`CORE::\*(C'\fR pseudo\-package.
106 .SH NOTE
107 .IX Header "NOTE"
108 While this class is currently implemented using the Class::Struct
109 module to build a struct\-like class, you shouldn\*(Aqt rely upon this.
110 .SH AUTHOR
111 .IX Header "AUTHOR"
112 Tom Christiansen