This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

GetIPAddress Element Documentation

NAME

GetIPAddress -- Click element; sets destination IP address annotation from packet data

SYNOPSIS

GetIPAddress(OFFSET [, ANNO, keyword IP])

Ports: 1 input, 1 output
Processing: agnostic
Package: ip (core)

DESCRIPTION

Copies 4 bytes from the packet, starting at OFFSET, to the destination IP address annotation. OFFSET is usually 16, to fetch the destination address from an IP packet. Set ANNO to set a non-default destination IP address annotation. You may also give an IP keyword argument instead of an OFFSET. IP must equal 'src' or 'dst'. The input packet must have its IP header annotation set. The named destination IP address annotation is set to that IP header's source or destination address, respectively.

NOTES

The destination address annotation is used by elements that need to know where the packet is going. Such elements include ARPQuerier and LookupIPRoute.

SEE ALSO

ARPQuerier, StaticIPLookup, SetIPAddress, StoreIPAddress

Generated by 'click-elem2man' from '../elements/ip/getipaddress.hh:7' on 12/Jul/2011.

COMMENTS

 
elements/getipaddress.txt · Last modified: 2011/07/12 11:29 (external edit)
 
Recent changes RSS feed Driven by DokuWiki