man pages section 3: Library Interfaces and Headers

IO::Socket::UNIX (3)

Name

IO::Socket::UNIX - Object interface for AF_UNIX domain sockets

Synopsis

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++) . "\n");
}

# Client:
my $client = IO::Socket::UNIX->new(
Type => SOCK_STREAM(),
Peer => $SOCK_PATH,
);

# Now read and write from $client

Description

Perl Programmers Reference Guide                           IO::Socket::UNIX(3)



NAME
       IO::Socket::UNIX - Object interface for AF_UNIX domain sockets

SYNOPSIS
           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++) . "\n");
           }

           # Client:
           my $client = IO::Socket::UNIX->new(
               Type => SOCK_STREAM(),
               Peer => $SOCK_PATH,
           );

           # Now read and write from $client

DESCRIPTION
       "IO::Socket::UNIX" 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.

CONSTRUCTOR
       new ( [ARGS] )
           Creates an "IO::Socket::UNIX" object, which is a reference to a
           newly created symbol (see the "Symbol" package). "new" optionally
           takes arguments, these arguments are in key-value pairs.

           In addition to the key-value pairs accepted by IO::Socket,
           "IO::Socket::UNIX" provides.

               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

           If the constructor is only passed a single argument, it is assumed
           to be a "Peer" specification.

           If the "Listen" argument is given, but false, the queue size will
           be set to 5.

METHODS
       hostpath()
           Returns the pathname to the fifo at the local end

       peerpath()
           Returns the pathanme to the fifo at the peer end


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       Socket, IO::Socket

AUTHOR
       Graham Barr. Currently maintained by the Perl Porters.  Please report
       all bugs to <perlbug@perl.org>.

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.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14               IO::Socket::UNIX(3)