.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Net::Interface::NetSymbols 3pm" .TH Net::Interface::NetSymbols 3pm "2016-10-01" "perl v5.24.1" "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" Net::Interface::NetSymbols \- AF_ PF_ IFxxx type symbols .SH "SYNOPSIS" .IX Header "SYNOPSIS" This module is built for this specific architecture during the \fImake\fR process using \fIinst/netsymbols.pl\fR. Do not edit this module, edit \&\fIinst/netsymbols.pl\fR instead. .PP This module contains symbols arrays only for use by Net::Interface, in all other respects it is \s-1NOT\s0 functional. It contains documentation and data arrays for this specific architecture. .PP \&\fB\s-1NOTE:\s0\fR \s-1WARNING \s0!! .PP .Vb 1 \& usage is Net::Interface .Ve .PP \&\fB\s-1NOT\s0\fR Net::Interface::NetSymbols .PP use Net::Interface qw( .PP .Vb 3 \& 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 .Ve .PP \&\s-1PF_UNSPEC PF_FILE PF_LOCAL PF_UNIX PF_INET PF_AX25 PF_IPX PF_APPLETALK PF_X25 PF_INET6 PF_ROSE\s0 PF_DECnet \s-1PF_PACKET PF_ROUTE PF_ASH PF_ECONET PF_MAX\s0 .PP \&\s-1IFF_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\s0 .PP \&\s-1IFF_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\s0 .PP :all :afs :pfs :ifs :iffs :iftype :scope .PP ); .SH "DESCRIPTION" .IX Header "DESCRIPTION" All of the \s-1AF_XXX\s0 and \s-1PF_XXX\s0 symbols available in local \f(CW\*(C`sys/socket.h\*(C'\fR plus usual aliases for \s-1AF_LOCAL\s0 i.e. (\s-1AF_FILE AF_UNIX PF_LOCAL PF_FILE PF_UNIX\s0) .PP All of the IFxxxx and \s-1IN6_IF\s0 symbols in \f(CW\*(C`net/if.h, netinet/in.h, netinet/in_var.h\*(C'\fR and their includes. .PP Symbols may be accessed for their numeric value or their string name. .PP .Vb 2 \& i.e. if ($family == AF_INET) \& do something... \& \& or print AF_INET \& will product the string "inet" .Ve .PP The same holds true for: .PP .Vb 2 \& printf("family is %s",AF_INET); \& or sprint("family is %s",AF_INET); .Ve .PP To print the numeric value of the \s-1SYMBOL\s0 do: .PP .Vb 1 \& print (0 + SYMBOL), "\en"; .Ve .PP On systems supporting \s-1IPV6,\s0 these additional symbols are available which may be applied to the address \fItype\fR to determine the address attributes. .PP .Vb 10 \& 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,"\en"; \& } .Ve .PP These symbols may be equated to the \fIscope\fR of the address. .PP .Vb 6 \& 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,"\en"; \& } .Ve .IP "\(bu" 4 :all Import all symbols .IP "\(bu" 4 :afs Import all \s-1AF_XXX\s0 symbols .IP "\(bu" 4 :pfs Import all \s-1PF_XXX\s0 symbols .IP "\(bu" 4 :ifs Import all IFxxxx symbols .IP "\(bu" 4 :iffs Import all \s-1IFF\s0 symbols .IP "\(bu" 4 :iftype Import all \s-1IPV6\s0 type symbols .IP "\(bu" 4 :scope Import all \s-1IPV6\s0 scope symbols .SH "non EXPORT functions" .IX Header "non EXPORT functions" .IP "\(bu" 4 \&\fINet::Interface::NetSymbols::NI_ENDVAL()\fR; .Sp Reports the highest symbol value +1 of :all symbols above. Used for testing. .IP "\(bu" 4 \&\fINet::Interface::NetSymbols::NI_UNIQUE()\fR; .Sp Returns a hash pointer to the \s-1AF_\s0 or \s-1PF_\s0 symbol values mapped to their character strings as defined for this architecture. .Sp .Vb 10 \& i.e. \& 0 => \*(AqPF_UNSPEC\*(Aq, \& 1 => \*(AqPF_LOCAL\*(Aq, \& 2 => \*(AqPF_INET\*(Aq, \& 3 => \*(AqPF_AX25\*(Aq, \& 4 => \*(AqPF_IPX\*(Aq, \& 5 => \*(AqPF_APPLETALK\*(Aq, \& 9 => \*(AqPF_X25\*(Aq, \& 10 => \*(AqPF_INET6\*(Aq, \& 11 => \*(AqPF_ROSE\*(Aq, \& 12 => \*(AqPF_DECnet\*(Aq, \& 17 => \*(AqPF_PACKET\*(Aq, \& 18 => \*(AqPF_ASH\*(Aq, \& 19 => \*(AqPF_ECONET\*(Aq, \& 42 => \*(AqPF_MAX\*(Aq, .Ve .SH "AUTHOR Michael Robinton " .IX Header "AUTHOR Michael Robinton " .SH "COPYRIGHT 2008\-2009" .IX Header "COPYRIGHT 2008-2009" Michael Robinton, all rights reserved. .PP This library is free software. You can distribute it and/or modify it under the same terms as Perl itself.