.\" -*- 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 "Paranoid::Network::Socket 3pm"
.TH Paranoid::Network::Socket 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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
Paranoid::Network::Socket \- Socket wrapper for seemless IPv6 support
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR lib/Paranoid/Network/Socket.pm, 2.10 2022/03/08 00:01:04 acorliss Exp $
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  # use Socket; # no longer needed
\&  use Paranoid::Network::Socket;
\&  use Paranoid::Network::Socket qw(:crlf);
\&
\&  $ipv6_enabled = has_ipv6();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is a wrapper for \fBSocket\fR\|(3) and \fBSocket6\fR\|(3), and is meant to
be used in lieu of using those packages directly.  Doing so removes any of the
version dependent support issues on Perl and its bundled \fBSocket\fR\|(3) where
IPv6 is concerned.
.PP
Starting in Perl 5.12 the beginnings of IPv6 support emerged in the bundled
\&\fBSocket\fR\|(3) module, but full IPv6 support didn't arrive until 5.14.  Prior
versions of Perl required the use of the external \fBSocket6\fR\|(3) module 
(available on CPAN).
.PP
With this module IPv6 support, if available, is brought in automatically at
runtime, regardless of where that support is provided.  It also makes a
default export of \fBinet_pton\fR and \fBinet_ntop\fR, something that \fBSocket\fR\|(3)
only does on request.
.PP
Finally, this module provides a \fBhas_ipv6\fR function which will return whether
your Perl has full IPv6 support.  Full support is determined by the presence
of \fBsockaddr_in6\fR.
.PP
All of the regular tag sets provided by either \fBSocket\fR modules are supported
by this module.
.SH "IMPORT LISTS"
.IX Header "IMPORT LISTS"
This module exports the following symbols by default:
.PP
.Vb 1
\&    has_ipv6 @Socket::EXPORT
.Ve
.PP
The following specialized import lists also exist:
.PP
.Vb 3
\&    List        Members
\&    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    all         @defaults @Socket::EXPORT_OK
.Ve
.PP
\&\fBNOTE:\fR As a substitute for using Socket directly, this also passes on all
the specialized targets of that module.
.SH SUBROUTINES/METHODS
.IX Header "SUBROUTINES/METHODS"
.SS has_ipv6
.IX Subsection "has_ipv6"
.Vb 1
\&    $ipv6_enabled = has_ipv6();
.Ve
.PP
Returns a boolean value denoting whether or not this module has full IPv6
support.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
.IP o 4
.IX Item "o"
Socket
.IP o 4
.IX Item "o"
Socket6 (optional)
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
.SH AUTHOR
.IX Header "AUTHOR"
Arthur Corliss (corliss@digitalmages.com)
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
This software is free software.  Similar to Perl, you can redistribute it
and/or modify it under the terms of either:
.PP
.Vb 7
\&  a)     the GNU General Public License
\&         <https://www.gnu.org/licenses/gpl\-1.0.html> as published by the 
\&         Free Software Foundation <http://www.fsf.org/>; either version 1
\&         <https://www.gnu.org/licenses/gpl\-1.0.html>, or any later version
\&         <https://www.gnu.org/licenses/license\-list.html#GNUGPL>, or
\&  b)     the Artistic License 2.0
\&         <https://opensource.org/licenses/Artistic\-2.0>,
.Ve
.PP
subject to the following additional term:  No trademark rights to
"Paranoid" have been or are conveyed under any of the above licenses.
However, "Paranoid" may be used fairly to describe this unmodified
software, in good faith, but not as a trademark.
.PP
(c) 2005 \- 2020, Arthur Corliss (corliss@digitalmages.com)
(tm) 2008 \- 2020, Paranoid Inc. (www.paranoid.com)