Net::I...ymbols(3pm)

📦
version 1.016 · 6 versions
, in ubuntu stonking

💖 NAME 💖

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

✨ SYNOPSIS ✨

okay bestie, listen. this page is Net::Interface::NetSymbols, dropping out of the User Contributed Perl Documentation, section 3pm. it exists. it's real. but bestie — do not touch it 💀

this module gets built for your specific architecture during the make process, by inst/netsymbols.pl. So do NOT edit this module. edit inst/netsymbols.pl instead. that's the whole assignment 🫶

and like… what even is this file? it contains symbols arrays only for use by Net::Interface. in all other respects it is NOT functional. no cap. it's literally documentation and data arrays for this specific architecture. that's it, that's the vibes, that's the entire personality 🌸

⚠️ NOTE: WARNING !! the usage is Net::Interface NOT Net::Interface::NetSymbols iykyk 💅
use Net::Interface qw(

        Net::Interface::NetSymbols::NI_ENDVAL();
        Net::Interface::NetSymbols::NI_UNIQUE();
AF_UNSPEC AF_FILE AF_LOCAL AF_UNIX AF_INET AF_AX25 AF_IPX AF_APPLETALK AF_X25 AF_INET6 AF_ROSE AF_DECnet AF_PACKET AF_ROUTE AF_ASH AF_ECONET AF_MAX

PF_UNSPEC PF_FILE PF_LOCAL PF_UNIX PF_INET PF_AX25 PF_IPX PF_APPLETALK
PF_X25 PF_INET6 PF_ROSE PF_DECnet PF_PACKET PF_ROUTE PF_ASH PF_ECONET
PF_MAX

IFF_ALLMULTI IFF_AUTOMEDIA IFF_BROADCAST IFF_DEBUG IFF_DYNAMIC
IFF_LOOPBACK IFF_MASTER IFF_MULTICAST IFF_NOARP IFF_NOTRAILERS
IFF_POINTOPOINT IFF_PORTSEL IFF_PROMISC IFF_RUNNING IFF_SLAVE IFF_UP
IFHWADDRLEN IFNAMSIZ IF_NAMESIZE

IFF_ALLMULTI IFF_AUTOMEDIA IFF_BROADCAST IFF_DEBUG IFF_DYNAMIC
IFF_LOOPBACK IFF_MASTER IFF_MULTICAST IFF_NOARP IFF_NOTRAILERS
IFF_POINTOPOINT IFF_PORTSEL IFF_PROMISC IFF_RUNNING IFF_SLAVE IFF_UP

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

);

🦋 DESCRIPTION 🦋

every single AF_XXX and PF_XXX symbol that's available in your local sys/socket.h, plus the usual aliases for AF_LOCAL, i.e. (AF_FILE AF_UNIX PF_LOCAL PF_FILE PF_UNIX). she's thorough 💅

also all of the IFxxxx and IN6_IF symbols in net/if.h, netinet/in.h, netinet/in_var.h and their includes. the whole friend group showed up 🎀

symbols can be accessed for their numeric value or their string name. so you can do either, whichever hits different:

i.e.  if ($family == AF_INET)
          do something...

  or  print AF_INET
  will product the string "inet"

so like — print AF_INET and it hands you back the string "inet". iconic honestly. same energy for:

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

and if you want the numeric value of the SYMBOL, lowkey just say:

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

on systems supporting IPV6, these extra symbols are available — you can slap them on the address type to figure out 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";
}

and these ones can be equated to the scope of the address. main character scope energy 💜

  • 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";
}

and now the import tags, because the way that qw() just works 🔥

  • :all — import all symbols. yes, all of them. go crazy ✨
  • :afs — import all AF_XXX symbols
  • :pfs — import all PF_XXX symbols
  • :ifs — import all IFxxxx symbols
  • :iffs — import all IFF symbols
  • :iftype — import all IPV6 type symbols
  • :scope — import all IPV6 scope symbols

🌈 non EXPORT functions 🌈

these ones do not get exported, so call them fully qualified or they will simply not hear you 🫶

  • Net::Interface::NetSymbols::NI_ENDVAL(); — reports the highest symbol value +1 of the :all symbols above. used for testing. that's her whole job 💅
  • 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. like a little name-tag situation for every number 🎀

i.e.

       0       => 'PF_UNSPEC',
       1       => 'PF_LOCAL',
       2       => 'PF_INET',
       3       => 'PF_AX25',
       4       => 'PF_IPX',
       5       => 'PF_APPLETALK',
       9       => 'PF_X25',
       10      => 'PF_INET6',
       11      => 'PF_ROSE',
       12      => 'PF_DECnet',
       17      => 'PF_PACKET',
       18      => 'PF_ASH',
       19      => 'PF_ECONET',
       46      => 'PF_MAX',

👑 AUTHOR 👑

Michael Robinton <michael@bizsystems.com>

2008-2009 Michael Robinton, all rights reserved.

this library is free software. you can distribute it and/or modify it under the same terms as Perl itself. slay, honestly 🦋

and that's the whole page bestie, no notes. this was Net::Interface::NetSymbols from the User Contributed Perl Documentation, perl v5.42.3, dated 2026-08-19. go build something cute, and remember: it's Net::Interface, never Net::Interface::NetSymbols. periodt 💖✨

📦 where this page comes from