view release on metacpan or  search on metacpan

lib/Net/SockAddr.pod  view on Meta::CPAN

=head1 NAME

Net::SockAddr - Socket address OO-wrapper with Perl and C++ interface.



=head1 DESCRIPTION

Supports AF_INET, AF_INET6 and AF_UNIX, can create sockaddrs and pack/unpack ips.



=head1 SYNOPSIS

    use Net::SockAddr;
    
    $sa = Net::SockAddr::Inet4->new("1.2.3.4", 80);
    $sa = Net::SockAddr::Inet6->new("2001:db8::ae21:ad12", 80);
    $sa = Net::SockAddr::Unix->new("/tmp/mysock");
    connect($sock, $sa->get);

    $sa = Net::SockAddr->new($connection->getpeername());
    if ($sa->is_inet4 or $sa->is_inet6) {
        say $sa->ip;
        say $sa->port;
    } else { # UNIX socket
        say $sa->path;
    }


                 
=head1 C SYNOPSIS

    #include <panda/net/sockaddr.h>
    using panda::net::SockAddr;
    
    
    
=head1 METHODS

=head4 new($sa)

Creates SockAddr object from C<$sa>. Return value will be of class L<Net::SockAddr::Inet4>, L<Net::SockAddr::Inet6> or L<Net::SockAddr::Unix>
depending on the C<$sa>.

C<$sa> may be:

=over

=item
    
    A binary string representing struct sockaddr_in/in6/un (like what Socket::sockaddr_in returns)
    
=item 

    A C<Net::SockAddr> object. In this case, copy is created.
    
=back

If C<$sa> is undefined or contains sockaddr with AF_UNSPEC family, constructor returns undef.

Classes L<Net::SockAddr::Inet4>, L<Net::SockAddr::Inet6> and L<Net::SockAddr::Unix> contains more specialised constructors from ip/port or path.

=head4 family()

Returns AF_INET / AF_INET6 / AF_UNIX

=head4 is_inet4()

Returns true if C<family == AF_INET>

=head4 is_inet6()

Returns true if C<family == AF_INET6>

=head4 is_unix()

Returns true if C<family == AF_UNIX>

=head4 get()

Returns binary string suitable for passing to Perl's C<connect()> functions (representing struct sockaddr_in/in6/un, like what Socket::sockaddr_in returns)

=head4 operator ""

Object stringifies to "ip:port" for IPv4, "[ip]:port" for IPv6 and "path" for AF_UNIX

=head4 operator==, operator!=

Two objects are equal if all properties of their underlying sockaddrs are equal



=head1 CONSTANTS

=over

=item AF_UNSPEC

=item AF_INET

=item AF_INET6

=item AF_UNIX

Only for Unix systems

=item INADDR_ANY

Binary IPv4 address for binding to all interfaces on machine.

    my $sa = Net::SockAddr::Inet4::from_addr(Net::SockAddr::INADDR_ANY, 80);
    $server->bind($sa);

=item INADDR_LOOPBACK

Binary IPv4 address of the loopback interface

=item INADDR_BROADCAST

Binary IPv4 broadcast address

=item INADDR_NONE

Binary IPv4 invalid address (usually '255.255.255.255')

=item SOCKADDR_ANY

IPv4 sockaddr for binding to all interfaces with auto-selected port.

    $server->bind(Net::SockAddr::SOCKADDR_ANY);