summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm')
-rw-r--r--upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm154
1 files changed, 154 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm b/upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm
new file mode 100644
index 00000000..ccaab71a
--- /dev/null
+++ b/upstream/mageia-cauldron/man3pm/IO::Socket::UNIX.3pm
@@ -0,0 +1,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 3pm"
+.TH IO::Socket::UNIX 3pm 2023-11-28 "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.