NAME

Net::Interface::NetSymbols - AF_ PF_ IFxxx type symbols

SYNOPSIS

This module is built for this specific architecture during the make process using inst/netsymbols.pl. Do not edit this module, edit inst/netsymbols.pl instead.

This module contains symbols arrays only for use by Net::Interface, in all other respects it is NOT functional. It contains documentation and data arrays for this specific architecture.

NOTE: WARNING !!

     usage is Net::Interface

NOT Net::Interface::NetSymbols

use Net::Interface qw(

        Net::Interface::NetSymbols::NI_ENDVAL();
        Net::Interface::NetSymbols::NI_UNIQUE();
AF_UNSPEC AF_LOCAL AF_FILE AF_UNIX AF_INET AF_BRIDGE AF_ISO AF_DECnet AF_APPLETALK AF_PACKET AF_ROUTE AF_LINK AF_IPX AF_INET6 AF_MAX

PF_UNSPEC PF_LOCAL PF_FILE PF_UNIX PF_INET PF_BRIDGE PF_ISO PF_DECnet PF_APPLETALK PF_PACKET PF_ROUTE PF_LINK PF_IPX PF_INET6 PF_MAX

IFCAP_B_WOL_MCAST IFF_MULTICAST IF_NAMESIZE IN6_IFF_PREFER_SOURCE IFCAP_B_RXTLS4 IFF_OACTIVE IFF_LINK2 IFCAP_B_MEXTPG IN6_IFF_TENTATIVE IFF_SIMPLEX IFCAP_B_NETCONS IFCAP_B_TXCSUM_IPV6 IFCAP_B_TXRTLMT IFCAP_B_TOE6 IFCAP_B_WOL_MAGIC IFCAP_B_RXCSUM IFF_RUNNING IFCAP_B_JUMBO_MTU IFF_LOOPBACK IN6_IFF_DEPRECATED IN6_IFF_NODAD IFCAP_B_VXLAN_HWCSUM IN6_IFF_ANYCAST IFCAP_B_HWSTATS IFQ_MAXLEN IFCAP_B_POLLING IFF_LINK0 IN6_IFAUPDATE_DADDELAY IFF_BROADCAST IFHWADDRLEN IFCAP_B_LRO IFCAP_B_TSO4 IN6_IFF_DUPLICATED IFAN_ARRIVAL IFCAP_B_VLAN_HWTAGGING IFNAMSIZ IFF_DRV_OACTIVE IFCAP_B_TXTLS_RTLMT IFCAP_B_WOL_UCAST IFCAP_B_RXTLS6 IFF_MONITOR IFF_ALLMULTI IFF_PROMISC IFF_NOARP IFDR_MSG_SIZE IFCAP_B_VLAN_HWCSUM IFCAP_B_NETMAP IFF_NEEDSEPOCH IFCAP_B_TSO6 IFSTATMAX IFCAP_B_VXLAN_HWTSO IFF_LINK1 IFCAP_B_NV IFF_UP IFCAP_B_HWRXTSTMP IFAN_DEPARTURE IFF_POINTOPOINT IN6_IFF_AUTOCONF IN6_IFF_DETACHED IFCAP_B_RXCSUM_IPV6 IFCAP_B_VLAN_MTU IFF_CANTCONFIG IFF_DEBUG IFCAP_B_TXCSUM IFF_DRV_RUNNING IFNET_SLOWHZ IFCAP_B_TXTLS4 IFF_DYING IFF_RENAMING IFDR_REASON_VENDOR IFCAP_B_LINKSTATE IFCAP_B_TXTLS6 IFF_ALTPHYS IFF_PPROMISC IFF_STICKYARP IFCAP_B_VLAN_HWFILTER IFF_PALLMULTI IFF_STATICARP IN6_IFF_TEMPORARY IFCAP_B_VLAN_HWTSO IFDR_REASON_MSG IFF_NETLINK_1 IFCAP_B_TOE4

IFF_ALLMULTI IFF_ALTPHYS IFF_BROADCAST IFF_CANTCONFIG IFF_DEBUG IFF_DYING IFF_LINK0 IFF_LINK1 IFF_LINK2 IFF_LOOPBACK IFF_MONITOR IFF_MULTICAST IFF_NEEDSEPOCH IFF_NETLINK_1 IFF_NOARP IFF_OACTIVE IFF_PALLMULTI IFF_POINTOPOINT IFF_PPROMISC IFF_PROMISC IFF_RENAMING IFF_RUNNING IFF_SIMPLEX IFF_STATICARP IFF_STICKYARP IFF_UP

IN6_IFF_ANYCAST IN6_IFF_AUTOCONF IN6_IFF_DEPRECATED IN6_IFF_DETACHED IN6_IFF_DUPLICATED IN6_IFF_NODAD IN6_IFF_PREFER_SOURCE IN6_IFF_TEMPORARY IN6_IFF_TENTATIVE populated for BSD flavored systems

:all :afs :pfs :ifs :iffs :iffIN6 :iftype :scope

);

DESCRIPTION

All of the AF_XXX and PF_XXX symbols available in local "sys/socket.h" plus usual aliases for AF_LOCAL i.e. (AF_FILE AF_UNIX PF_LOCAL PF_FILE PF_UNIX)

All of the IFxxxx and IN6_IF symbols in "net/if.h, netinet/in.h, netinet/in_var.h" and their includes.

Symbols may be accessed for their numeric value or their string name.

  i.e.  if ($family == AF_INET)
            do something...
    or  print AF_INET
    will product the string "inet"

The same holds true for:

        printf("family is %s",AF_INET);
    or  sprint("family is %s",AF_INET);

To print the numeric value of the SYMBOL do:

        print (0 + SYMBOL), "\n";

On systems supporting IPV6, these additional symbols are available which may be applied to the address type to determine the address attributes.

    IPV6_ADDR_ANY               unknown
    IPV6_ADDR_UNICAST           unicast
    IPV6_ADDR_MULTICAST         multicast
    IPV6_ADDR_ANYCAST           anycast
    IPV6_ADDR_LOOPBACK          loopback
    IPV6_ADDR_LINKLOCAL         link-local
    IPV6_ADDR_SITELOCAL         site-local
    IPV6_ADDR_COMPATv4          compat-v4
    IPV6_ADDR_SCOPE_MASK        scope-mask
    IPV6_ADDR_MAPPED            mapped
    IPV6_ADDR_RESERVED          reserved
    IPV6_ADDR_ULUA              uniq-lcl-unicast
    IPV6_ADDR_6TO4              6to4
    IPV6_ADDR_6BONE             6bone
    IPV6_ADDR_AGU               global-unicast
    IPV6_ADDR_UNSPECIFIED       unspecified
    IPV6_ADDR_SOLICITED_NODE    solicited-node
    IPV6_ADDR_ISATAP            ISATAP
    IPV6_ADDR_PRODUCTIVE        productive
    IPV6_ADDR_6TO4_MICROSOFT    6to4-ms
    IPV6_ADDR_TEREDO            teredo
    IPV6_ADDR_ORCHID            orchid
    IPV6_ADDR_NON_ROUTE_DOC     non-routeable-doc
    if ($type & IPV6_ADDR_xxxx) {
        print IPV6_ADDR_xxxx,"\n";
    }

These symbols may be equated to the scope of the address.

    RFC2373_GLOBAL              global-scope
    RFC2373_ORGLOCAL            org-local
    RFC2373_SITELOCAL           site-local
    RFC2373_LINKLOCAL           link-local
    RFC2373_NODELOCAL           loopback
    LINUX_COMPATv4              lx-compat-v4
    if ($scope eq RFC2373_xxxx) {
        print RFC2373_xxxx,"\n";
    }

:all Import all symbols
:afs Import all AF_XXX symbols
:pfs Import all PF_XXX symbols
:ifs Import all IFxxxx symbols
:iffs Import all IFF symbols
:iffIN6 Import all IN6_IFF symbols (BSD flavors only)
:iftype Import all IPV6 type symbols
:scope Import all IPV6 scope symbols

non EXPORT functions

Net::Interface::NetSymbols::NI_ENDVAL();
Reports the highest symbol value +1 of :all symbols above. Used for testing.

Net::Interface::NetSymbols::NI_UNIQUE();

Returns a hash pointer to the AF_ or PF_ symbol values mapped to their character strings as defined for this architecture.

  i.e.
        0       => 'AF_UNSPEC',
        1       => 'AF_UNIX',
        2       => 'AF_INET',
        7       => 'AF_ISO',
        12      => 'AF_DECnet',
        16      => 'AF_APPLETALK',
        17      => 'AF_ROUTE',
        18      => 'AF_LINK',
        19      => 'IFCAP_B_LINKSTATE',
        22      => 'IFCAP_B_TXCSUM_IPV6',
        23      => 'AF_IPX',
        25      => 'IFCAP_B_HWRXTSTMP',
        27      => 'IFCAP_B_TXTLS4',
        28      => 'AF_INET6',
        31      => 'IFCAP_B_TXTLS_RTLMT',
        50      => 'IFQ_MAXLEN',
        64      => 'IFF_DRV_RUNNING',
        128     => 'IFF_NOARP',
        256     => 'IFF_PROMISC',
        512     => 'IFF_ALLMULTI',
        800     => 'IFSTATMAX',
        1024    => 'IFF_DRV_OACTIVE',
        2048    => 'IFF_SIMPLEX',
        4096    => 'IFF_LINK0',
        8192    => 'IFF_LINK1',
        16384   => 'IFF_LINK2',
        32768   => 'IFF_MULTICAST',
        65536   => 'IFF_CANTCONFIG',
        131072  => 'IFF_PPROMISC',
        262144  => 'IFF_MONITOR',
        524288  => 'IFF_STATICARP',
        1048576 => 'IFF_STICKYARP',
        2097152 => 'IFF_DYING',
        4194304 => 'IFF_RENAMING',
        8388608 => 'IFF_PALLMULTI',
        16777216        => 'IFF_NETLINK_1',

AUTHOR Michael Robinton <michael@bizsystems.com>

COPYRIGHT 2025

This library is free software. You can distribute it and/or modify it under the same terms as Perl itself.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 442:: You forgot a '=back' before '=head1'