route.h File Reference

#include <stdint.h>
#include <sys/appleapiopts.h>
#include <sys/socket.h>
#include <sys/types.h>

Classes
struct	rt_metrics
struct	rtstat
struct	rt_msghdr
struct	rt_msghdr2
struct	rt_addrinfo

Macros
#define	RTM_RTTUNIT   1000000 /* units for rtt, rttvar, as units per sec */
#define	RTF_UP   0x1 /* route usable */
#define	RTF_GATEWAY   0x2 /* destination is a gateway */
#define	RTF_HOST   0x4 /* host entry (net otherwise) */
#define	RTF_REJECT   0x8 /* host or net unreachable */
#define	RTF_DYNAMIC   0x10 /* created dynamically (by redirect) */
#define	RTF_MODIFIED   0x20 /* modified dynamically (by redirect) */
#define	RTF_DONE   0x40 /* message confirmed */
#define	RTF_DELCLONE   0x80 /* delete cloned route */
#define	RTF_CLONING   0x100 /* generate new routes on use */
#define	RTF_XRESOLVE   0x200 /* external daemon resolves name */
#define	RTF_LLINFO   0x400 /* generated by link layer (e.g. ARP) */
#define	RTF_STATIC   0x800 /* manually added */
#define	RTF_BLACKHOLE   0x1000 /* just discard pkts (during updates) */
#define	RTF_NOIFREF   0x2000 /* not eligible for RTF_IFREF */
#define	RTF_PROTO2   0x4000 /* protocol specific routing flag */
#define	RTF_PROTO1   0x8000 /* protocol specific routing flag */
#define	RTF_PRCLONING   0x10000 /* protocol requires cloning */
#define	RTF_WASCLONED   0x20000 /* route generated through cloning */
#define	RTF_PROTO3   0x40000 /* protocol specific routing flag */
#define	RTF_PINNED   0x100000 /* future use */
#define	RTF_LOCAL   0x200000 /* route represents a local address */
#define	RTF_BROADCAST   0x400000 /* route represents a bcast address */
#define	RTF_MULTICAST   0x800000 /* route represents a mcast address */
#define	RTF_IFSCOPE   0x1000000 /* has valid interface scope */
#define	RTF_CONDEMNED   0x2000000 /* defunct; no longer modifiable */
#define	RTF_IFREF   0x4000000 /* route holds a ref to interface */
#define	RTF_PROXY   0x8000000 /* proxying, no interface scope */
#define	RTF_ROUTER   0x10000000 /* host is a router */
#define	RTF_BITS
#define	RTM_VERSION   5 /* Up the ante and ignore older versions */
#define	RTM_ADD   0x1 /* Add Route */
#define	RTM_DELETE   0x2 /* Delete Route */
#define	RTM_CHANGE   0x3 /* Change Metrics or flags */
#define	RTM_GET   0x4 /* Report Metrics */
#define	RTM_LOSING
#define	RTM_REDIRECT   0x6 /* Told to use different route */
#define	RTM_MISS   0x7 /* Lookup failed on this address */
#define	RTM_LOCK   0x8 /* fix specified metrics */
#define	RTM_OLDADD   0x9 /* caused by SIOCADDRT */
#define	RTM_OLDDEL   0xa /* caused by SIOCDELRT */
#define	RTM_RESOLVE   0xb /* req to resolve dst to LL addr */
#define	RTM_NEWADDR   0xc /* address being added to iface */
#define	RTM_DELADDR   0xd /* address being removed from iface */
#define	RTM_IFINFO   0xe /* iface going up/down etc. */
#define	RTM_NEWMADDR   0xf /* mcast group membership being added to if */
#define	RTM_DELMADDR   0x10 /* mcast group membership being deleted */
#define	RTM_IFINFO2   0x12 /* */
#define	RTM_NEWMADDR2   0x13 /* */
#define	RTM_GET2   0x14 /* */
#define	RTV_MTU   0x1 /* init or lock _mtu */
#define	RTV_HOPCOUNT   0x2 /* init or lock _hopcount */
#define	RTV_EXPIRE   0x4 /* init or lock _expire */
#define	RTV_RPIPE   0x8 /* init or lock _recvpipe */
#define	RTV_SPIPE   0x10 /* init or lock _sendpipe */
#define	RTV_SSTHRESH   0x20 /* init or lock _ssthresh */
#define	RTV_RTT   0x40 /* init or lock _rtt */
#define	RTV_RTTVAR   0x80 /* init or lock _rttvar */
#define	RTA_DST   0x1 /* destination sockaddr present */
#define	RTA_GATEWAY   0x2 /* gateway sockaddr present */
#define	RTA_NETMASK   0x4 /* netmask sockaddr present */
#define	RTA_GENMASK   0x8 /* cloning mask sockaddr present */
#define	RTA_IFP   0x10 /* interface name sockaddr present */
#define	RTA_IFA   0x20 /* interface addr sockaddr present */
#define	RTA_AUTHOR   0x40 /* sockaddr for author of redirect */
#define	RTA_BRD   0x80 /* for NEWADDR, broadcast or p-p dest addr */
#define	RTAX_DST   0 /* destination sockaddr present */
#define	RTAX_GATEWAY   1 /* gateway sockaddr present */
#define	RTAX_NETMASK   2 /* netmask sockaddr present */
#define	RTAX_GENMASK   3 /* cloning mask sockaddr present */
#define	RTAX_IFP   4 /* interface name sockaddr present */
#define	RTAX_IFA   5 /* interface addr sockaddr present */
#define	RTAX_AUTHOR   6 /* sockaddr for author of redirect */
#define	RTAX_BRD   7 /* for NEWADDR, broadcast or p-p dest addr */
#define	RTAX_MAX   8 /* size of array to allocate */

Macro Definition Documentation

RTA_AUTHOR

#define RTA_AUTHOR   0x40 /* sockaddr for author of redirect */

RTA_BRD

#define RTA_BRD   0x80 /* for NEWADDR, broadcast or p-p dest addr */

RTA_DST

#define RTA_DST   0x1 /* destination sockaddr present */

RTA_GATEWAY

#define RTA_GATEWAY   0x2 /* gateway sockaddr present */

RTA_GENMASK

#define RTA_GENMASK   0x8 /* cloning mask sockaddr present */

RTA_IFA

#define RTA_IFA   0x20 /* interface addr sockaddr present */

RTA_IFP

#define RTA_IFP   0x10 /* interface name sockaddr present */

RTA_NETMASK

#define RTA_NETMASK   0x4 /* netmask sockaddr present */

RTAX_AUTHOR

#define RTAX_AUTHOR   6 /* sockaddr for author of redirect */

RTAX_BRD

#define RTAX_BRD   7 /* for NEWADDR, broadcast or p-p dest addr */

RTAX_DST

#define RTAX_DST   0 /* destination sockaddr present */

RTAX_GATEWAY

#define RTAX_GATEWAY   1 /* gateway sockaddr present */

RTAX_GENMASK

#define RTAX_GENMASK   3 /* cloning mask sockaddr present */

RTAX_IFA

#define RTAX_IFA   5 /* interface addr sockaddr present */

RTAX_IFP

#define RTAX_IFP   4 /* interface name sockaddr present */

RTAX_MAX

#define RTAX_MAX   8 /* size of array to allocate */

RTAX_NETMASK

#define RTAX_NETMASK   2 /* netmask sockaddr present */

RTF_BITS

#define RTF_BITS

Value:

  "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE"                                       \
  "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE"                                 \
  "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3"                                  \
  "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED"                                \
  "\33IFREF\34PROXY\35ROUTER"

RTF_BLACKHOLE

#define RTF_BLACKHOLE   0x1000 /* just discard pkts (during updates) */

RTF_BROADCAST

#define RTF_BROADCAST   0x400000 /* route represents a bcast address */

RTF_CLONING

#define RTF_CLONING   0x100 /* generate new routes on use */

RTF_CONDEMNED

#define RTF_CONDEMNED   0x2000000 /* defunct; no longer modifiable */

RTF_DELCLONE

#define RTF_DELCLONE   0x80 /* delete cloned route */

RTF_DONE

#define RTF_DONE   0x40 /* message confirmed */

RTF_DYNAMIC

#define RTF_DYNAMIC   0x10 /* created dynamically (by redirect) */

RTF_GATEWAY

#define RTF_GATEWAY   0x2 /* destination is a gateway */

RTF_HOST

#define RTF_HOST   0x4 /* host entry (net otherwise) */

RTF_IFREF

#define RTF_IFREF   0x4000000 /* route holds a ref to interface */

RTF_IFSCOPE

#define RTF_IFSCOPE   0x1000000 /* has valid interface scope */

RTF_LLINFO

#define RTF_LLINFO   0x400 /* generated by link layer (e.g. ARP) */

RTF_LOCAL

#define RTF_LOCAL   0x200000 /* route represents a local address */

RTF_MODIFIED

#define RTF_MODIFIED   0x20 /* modified dynamically (by redirect) */

RTF_MULTICAST

#define RTF_MULTICAST   0x800000 /* route represents a mcast address */

RTF_NOIFREF

#define RTF_NOIFREF   0x2000 /* not eligible for RTF_IFREF */

RTF_PINNED

#define RTF_PINNED   0x100000 /* future use */

RTF_PRCLONING

#define RTF_PRCLONING   0x10000 /* protocol requires cloning */

RTF_PROTO1

#define RTF_PROTO1   0x8000 /* protocol specific routing flag */

RTF_PROTO2

#define RTF_PROTO2   0x4000 /* protocol specific routing flag */

RTF_PROTO3

#define RTF_PROTO3   0x40000 /* protocol specific routing flag */

RTF_PROXY

#define RTF_PROXY   0x8000000 /* proxying, no interface scope */

RTF_REJECT

#define RTF_REJECT   0x8 /* host or net unreachable */

RTF_ROUTER

#define RTF_ROUTER   0x10000000 /* host is a router */

RTF_STATIC

#define RTF_STATIC   0x800 /* manually added */

RTF_UP

#define RTF_UP   0x1 /* route usable */

RTF_WASCLONED

#define RTF_WASCLONED   0x20000 /* route generated through cloning */

RTF_XRESOLVE

#define RTF_XRESOLVE   0x200 /* external daemon resolves name */

RTM_ADD

#define RTM_ADD   0x1 /* Add Route */

RTM_CHANGE

#define RTM_CHANGE   0x3 /* Change Metrics or flags */

RTM_DELADDR

#define RTM_DELADDR   0xd /* address being removed from iface */

RTM_DELETE

#define RTM_DELETE   0x2 /* Delete Route */

RTM_DELMADDR

#define RTM_DELMADDR   0x10 /* mcast group membership being deleted */

RTM_GET

#define RTM_GET   0x4 /* Report Metrics */

RTM_GET2

#define RTM_GET2   0x14 /* */

RTM_IFINFO

#define RTM_IFINFO   0xe /* iface going up/down etc. */

RTM_IFINFO2

#define RTM_IFINFO2   0x12 /* */

RTM_LOCK

#define RTM_LOCK   0x8 /* fix specified metrics */

RTM_LOSING

#define RTM_LOSING

Value:

  0x5                      /* RTM_LOSING is no longer generated by xnu
           and is deprecated */

RTM_MISS

#define RTM_MISS   0x7 /* Lookup failed on this address */

RTM_NEWADDR

#define RTM_NEWADDR   0xc /* address being added to iface */

RTM_NEWMADDR

#define RTM_NEWMADDR   0xf /* mcast group membership being added to if */

RTM_NEWMADDR2

#define RTM_NEWMADDR2   0x13 /* */

RTM_OLDADD

#define RTM_OLDADD   0x9 /* caused by SIOCADDRT */

RTM_OLDDEL

#define RTM_OLDDEL   0xa /* caused by SIOCDELRT */

RTM_REDIRECT

#define RTM_REDIRECT   0x6 /* Told to use different route */

RTM_RESOLVE

#define RTM_RESOLVE   0xb /* req to resolve dst to LL addr */

RTM_RTTUNIT

#define RTM_RTTUNIT   1000000 /* units for rtt, rttvar, as units per sec */

RTM_VERSION

#define RTM_VERSION   5 /* Up the ante and ignore older versions */

RTV_EXPIRE

#define RTV_EXPIRE   0x4 /* init or lock _expire */

RTV_HOPCOUNT

#define RTV_HOPCOUNT   0x2 /* init or lock _hopcount */

RTV_MTU

#define RTV_MTU   0x1 /* init or lock _mtu */

RTV_RPIPE

#define RTV_RPIPE   0x8 /* init or lock _recvpipe */

RTV_RTT

#define RTV_RTT   0x40 /* init or lock _rtt */

RTV_RTTVAR

#define RTV_RTTVAR   0x80 /* init or lock _rttvar */

RTV_SPIPE

#define RTV_SPIPE   0x10 /* init or lock _sendpipe */

RTV_SSTHRESH

#define RTV_SSTHRESH   0x20 /* init or lock _ssthresh */