Annotation of embedaddon/libnet/doc/man/man3/libnet-macros.h.3, revision 1.1
1.1 ! misho 1: .TH "libnet-macros.h" 3 "10 Mar 2004" "libnet" \" -*- nroff -*-
! 2: .ad l
! 3: .nh
! 4: .SH NAME
! 5: libnet-macros.h \- libnet macros and symbloc constants
! 6:
! 7: .SH SYNOPSIS
! 8: .br
! 9: .PP
! 10: .SS "Defines"
! 11:
! 12: .in +1c
! 13: .ti -1c
! 14: .RI "#define \fBLIBNET_DONT_RESOLVE\fP 0"
! 15: .br
! 16: .ti -1c
! 17: .RI "#define \fBLIBNET_RESOLVE\fP 1"
! 18: .br
! 19: .ti -1c
! 20: .RI "#define \fBLIBNET_ON\fP 0"
! 21: .br
! 22: .ti -1c
! 23: .RI "#define \fBLIBNET_OFF\fP 1"
! 24: .br
! 25: .ti -1c
! 26: .RI "#define \fBIN6ADDR_ERROR_INIT\fP"
! 27: .br
! 28: .ti -1c
! 29: .RI "#define \fBLIBNET_PR2\fP 0"
! 30: .br
! 31: .ti -1c
! 32: .RI "#define \fBLIBNET_PR8\fP 1"
! 33: .br
! 34: .ti -1c
! 35: .RI "#define \fBLIBNET_PR16\fP 2"
! 36: .br
! 37: .ti -1c
! 38: .RI "#define \fBLIBNET_PRu16\fP 3"
! 39: .br
! 40: .ti -1c
! 41: .RI "#define \fBLIBNET_PR32\fP 4"
! 42: .br
! 43: .ti -1c
! 44: .RI "#define \fBLIBNET_PRu32\fP 5"
! 45: .br
! 46: .ti -1c
! 47: .RI "#define \fBLIBNET_PRAND_MAX\fP 0xffffffff"
! 48: .br
! 49: .ti -1c
! 50: .RI "#define \fBLIBNET_MAX_PACKET\fP 0xffff"
! 51: .br
! 52: .ti -1c
! 53: .RI "#define \fBIP_MAXPACKET\fP 0xffff"
! 54: .br
! 55: .ti -1c
! 56: .RI "#define \fBETHER_ADDR_LEN\fP 0x6"
! 57: .br
! 58: .ti -1c
! 59: .RI "#define \fBFDDI_ADDR_LEN\fP 0x6"
! 60: .br
! 61: .ti -1c
! 62: .RI "#define \fBTOKEN_RING_ADDR_LEN\fP 0x6"
! 63: .br
! 64: .ti -1c
! 65: .RI "#define \fBLIBNET_ORG_CODE_SIZE\fP 0x3"
! 66: .br
! 67: .ti -1c
! 68: .RI "#define \fBLIBNET_ERRBUF_SIZE\fP 0x100"
! 69: .br
! 70: .ti -1c
! 71: .RI "#define \fBLIBNET_MAXOPTION_SIZE\fP 0x28"
! 72: .br
! 73: .ti -1c
! 74: .RI "#define \fBFIX\fP(n) (n)"
! 75: .br
! 76: .ti -1c
! 77: .RI "#define \fBUNFIX\fP(n) (n)"
! 78: .br
! 79: .ti -1c
! 80: .RI "#define \fBLIBNET_CKSUM_CARRY\fP(x) (x = (x >> 16) + (x & 0xffff), (~(x + (x >> 16)) & 0xffff))"
! 81: .br
! 82: .ti -1c
! 83: .RI "#define \fBLIBNET_OSPF_AUTHCPY\fP(x, y) memcpy((u_int8_t *)x, (u_int8_t *)y, sizeof(y))"
! 84: .br
! 85: .ti -1c
! 86: .RI "#define \fBLIBNET_OSPF_CKSUMBUF\fP(x, y) memcpy((u_int8_t *)x, (u_int8_t *)y, sizeof(y))"
! 87: .br
! 88: .ti -1c
! 89: .RI "#define \fBLIBNET_NTP_DO_LI_VN_MODE\fP(li, vn, md) ((u_int8_t)((((li) << 6) & 0xc0) | (((vn) << 3) & 0x38) | ((md) & 0x7)))"
! 90: .br
! 91: .ti -1c
! 92: .RI "#define \fBLIBNET_ISLOOPBACK\fP(p) (strcmp((p)->ifr_name, 'lo0') == 0)"
! 93: .br
! 94: .ti -1c
! 95: .RI "#define \fBLIBNET_ISADVMODE\fP(x) (x & 0x08)"
! 96: .br
! 97: .ti -1c
! 98: .RI "#define \fBLIBNET_LABEL_SIZE\fP 64"
! 99: .br
! 100: .ti -1c
! 101: .RI "#define \fBLIBNET_LABEL_DEFAULT\fP 'cardshark'"
! 102: .br
! 103: .ti -1c
! 104: .RI "#define \fBCQ_LOCK_UNLOCKED\fP (u_int)0x00000000"
! 105: .br
! 106: .ti -1c
! 107: .RI "#define \fBCQ_LOCK_READ\fP (u_int)0x00000001"
! 108: .br
! 109: .ti -1c
! 110: .RI "#define \fBCQ_LOCK_WRITE\fP (u_int)0x00000002"
! 111: .br
! 112: .ti -1c
! 113: .RI "#define \fBfor_each_context_in_cq\fP(l) for (l = libnet_cq_head(); libnet_cq_last(); l = libnet_cq_next())"
! 114: .br
! 115: .ti -1c
! 116: .RI "#define \fBcq_is_wlocked\fP() (l_cqd.cq_lock & CQ_LOCK_WRITE)"
! 117: .br
! 118: .ti -1c
! 119: .RI "#define \fBcq_is_rlocked\fP() (l_cqd.cq_lock & CQ_LOCK_READ)"
! 120: .br
! 121: .ti -1c
! 122: .RI "#define \fBcq_is_locked\fP() (l_cqd.cq_lock & (CQ_LOCK_READ | CQ_LOCK_WRITE))"
! 123: .br
! 124: .ti -1c
! 125: .RI "#define \fBcheck_cq_lock\fP(x) (l_cqd.cq_lock & x)"
! 126: .br
! 127: .in -1c
! 128: .SH "Detailed Description"
! 129: .PP
! 130: libnet macros and symbloc constants
! 131:
! 132:
! 133: .SH "Define Documentation"
! 134: .PP
! 135: .SS "#define for_each_context_in_cq(l) for (l = libnet_cq_head(); libnet_cq_last(); l = libnet_cq_next())"
! 136: .PP
! 137: Provides an interface to iterate through the context queue of libnet contexts. Before calling this macro, be sure to set the queue using \fBlibnet_cq_head()\fP.
! 138: .SS "#define IN6ADDR_ERROR_INIT"
! 139: .PP
! 140: \fBValue:\fP.nf
! 141: { { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
! 142: 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
! 143: 0xff, 0xff } } }
! 144: .fi
! 145: IPv6 error code
! 146: .SS "#define LIBNET_DONT_RESOLVE 0"
! 147: .PP
! 148: Used for libnet's name resolution functions, specifies that no DNS lookups should be performed and the IP address should be kept in numeric form.
! 149: .SS "#define LIBNET_ERRBUF_SIZE 0x100"
! 150: .PP
! 151: The libnet error buffer is 256 bytes long.
! 152: .SS "#define LIBNET_MAX_PACKET 0xffff"
! 153: .PP
! 154: The biggest an IP packet can be -- 65,535 bytes.
! 155: .SS "#define LIBNET_MAXOPTION_SIZE 0x28"
! 156: .PP
! 157: IP and TCP options can be up to 40 bytes long.
! 158: .SS "#define LIBNET_OFF 1"
! 159: .PP
! 160: Used several places, to specify 'on' or 'one'
! 161: .SS "#define LIBNET_ON 0"
! 162: .PP
! 163: Used several places, to specify 'on' or 'one'
! 164: .SS "#define LIBNET_PR2 0"
! 165: .PP
! 166: Used for \fBlibnet_get_prand()\fP to specify function disposition
! 167: .SS "#define LIBNET_RESOLVE 1"
! 168: .PP
! 169: Used for libnet's name resolution functions, specifies that a DNS lookup can be performed if needed to resolve the IP address to a canonical form.
! 170: .SH "Author"
! 171: .PP
! 172: Generated automatically by Doxygen for libnet from the source code.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>