1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IO::Socket::UNIX 3perl"
.TH IO::Socket::UNIX 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
IO::Socket::UNIX \- Object interface for AF_UNIX domain sockets
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use IO::Socket::UNIX;
\&
\& my $SOCK_PATH = "$ENV{HOME}/unix\-domain\-socket\-test.sock";
\&
\& # Server:
\& my $server = IO::Socket::UNIX\->new(
\& Type => SOCK_STREAM(),
\& Local => $SOCK_PATH,
\& Listen => 1,
\& );
\&
\& my $count = 1;
\& while (my $conn = $server\->accept()) {
\& $conn\->print("Hello " . ($count++) . "\en");
\& }
\&
\& # Client:
\& my $client = IO::Socket::UNIX\->new(
\& Type => SOCK_STREAM(),
\& Peer => $SOCK_PATH,
\& );
\&
\& # Now read and write from $client
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`IO::Socket::UNIX\*(C'\fR provides an object interface to creating and using sockets
in the AF_UNIX domain. It is built upon the IO::Socket interface and
inherits all the methods defined by IO::Socket.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.IP "new ( [ARGS] )" 4
.IX Item "new ( [ARGS] )"
Creates an \f(CW\*(C`IO::Socket::UNIX\*(C'\fR object, which is a reference to a
newly created symbol (see the Symbol package). \f(CW\*(C`new\*(C'\fR
optionally takes arguments, these arguments are in key-value pairs.
.Sp
In addition to the key-value pairs accepted by IO::Socket,
\&\f(CW\*(C`IO::Socket::UNIX\*(C'\fR provides.
.Sp
.Vb 4
\& Type Type of socket (eg SOCK_STREAM or SOCK_DGRAM)
\& Local Path to local fifo
\& Peer Path to peer fifo
\& Listen Queue size for listen
.Ve
.Sp
If the constructor is only passed a single argument, it is assumed to
be a \f(CW\*(C`Peer\*(C'\fR specification.
.Sp
If the \f(CW\*(C`Listen\*(C'\fR argument is given, but false, the queue size will be set to 5.
.Sp
If the constructor fails it will return \f(CW\*(C`undef\*(C'\fR and set the
\&\f(CW$IO::Socket::errstr\fR package variable to contain an error message.
.Sp
.Vb 2
\& $sock = IO::Socket::UNIX\->new(...)
\& or die "Cannot create socket \- $IO::Socket::errstr\en";
.Ve
.Sp
For legacy reasons the error message is also set into the global \f(CW$@\fR
variable, and you may still find older code which looks here instead.
.Sp
.Vb 2
\& $sock = IO::Socket::UNIX\->new(...)
\& or die "Cannot create socket \- $@\en";
.Ve
.SH METHODS
.IX Header "METHODS"
.IP \fBhostpath()\fR 4
.IX Item "hostpath()"
Returns the pathname to the fifo at the local end
.IP \fBpeerpath()\fR 4
.IX Item "peerpath()"
Returns the pathanme to the fifo at the peer end
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Socket, IO::Socket
.SH AUTHOR
.IX Header "AUTHOR"
Graham Barr. Currently maintained by the Perl Porters. Please report all
bugs at <https://github.com/Perl/perl5/issues>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 1996\-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
|
