Debian Codegraph @

upstream/debian-unstable/man3/Net::servent.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::servent 3perl"
58 .TH Net::servent 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::servent \- by\-name interface to Perl's built\-in getserv*() functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 4
68 \& use Net::servent;
69 \& my $s = getservbyname(shift || \*(Aqftp\*(Aq) || die "no service";
70 \& printf "port for %s is %s, aliases are %s\en",
71 \& $s\->name, $s\->port, "@{$s\->aliases}";
72 \&
73 \& use Net::servent qw(:FIELDS);
74 \& getservbyname(shift || \*(Aqftp\*(Aq) || die "no service";
75 \& print "port for $s_name is $s_port, aliases are @s_aliases\en";
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This module's default exports override the core \fBgetservent()\fR,
80 \&\fBgetservbyname()\fR, and
81 \&\fBgetnetbyport()\fR functions, replacing them with versions that return
82 "Net::servent" objects. They take default second arguments of "tcp". This object has methods that return the similarly
83 named structure field name from the C's servent structure from \fInetdb.h\fR;
84 namely name, aliases, port, and proto. The aliases
85 method 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`s_\*(C'\fR. Thus, \f(CW\*(C`$serv_obj\->name()\*(C'\fR corresponds to
91 \&\f(CW$s_name\fR if you import the fields. Array references are available as
92 regular array variables, so for example \f(CW\*(C`@{ $serv_obj\->aliases()}\*(C'\fR
93 would be simply \f(CW@s_aliases\fR.
94 .PP
95 The \fBgetserv()\fR function is a simple front-end that forwards a numeric
96 argument to \fBgetservbyport()\fR, and the rest to \fBgetservbyname()\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 EXAMPLES
104 .IX Header "EXAMPLES"
105 .Vb 1
106 \& use Net::servent qw(:FIELDS);
107 \&
108 \& while (@ARGV) {
109 \& my ($service, $proto) = ((split m!/!, shift), \*(Aqtcp\*(Aq);
110 \& my $valet = getserv($service, $proto);
111 \& unless ($valet) {
112 \& warn "$0: No service: $service/$proto\en"
113 \& next;
114 \& }
115 \& printf "service $service/$proto is port %d\en", $valet\->port;
116 \& print "alias are @s_aliases\en" if @s_aliases;
117 \& }
118 .Ve
119 .SH NOTE
120 .IX Header "NOTE"
121 While this class is currently implemented using the Class::Struct
122 module to build a struct-like class, you shouldn't rely upon this.
123 .SH AUTHOR
124 .IX Header "AUTHOR"
125 Tom Christiansen