Data Types
[FIP Architecture]

Collaboration diagram for Data Types:

Data Structures
struct	fip_ip6addr_flags_t
	Holds flags with additional information about any addresses. More...
struct	fip_ip6addr_t
	IPv6 address, held as an array of 16 bytes. More...
struct	fip_myip6addr_t
	IPv6 address with additional state. More...
struct	fip_myip6prefix_t
	IPv6 Prefix with additional state. More...
struct	fip_mydefrouter_t
	IPv6 Default Router with additional state. More...
struct	fip_ip6frag_attr_t
	Scratchpad for IPv6 Fragmentation. More...
Typedefs
typedef bool	fip_bool_t
	Typedef the C99 bool type.
typedef uint32_t	fip_vlifetime_t
	Address life-times.
Enumerations
enum	fip_return_t {   RV_OK = 0, RV_UNKNOWN_ERROR, RV_MEMORY_ERROR, RV_PARAMETER_ERROR,   RV_UNHANDLED, RV_ND6_INVALID_STATE, RV_ND6_NOENTRY, RV_RH4_SEGMENT_LEFT_ERROR,   RV_RH4_HOPS_EXCEEDED, RV_RH4_ADDRESS_OFF_LINK, RV_RH4_PROCESS_NEXT_HEADER, RV_HBH_RPL_INSTANCE_ERROR,   RV_HBH_RANK_ERROR }
	The return value used when functions are only returning a status, and nothing else. More...
enum	fip_addrtype_t {   ADDR_UNKNOWN = 0, ADDR_AUTOCONF = 1, ADDR_STATEFUL = 2, ADDR_MANUAL = 3,   ADDR_MULTICAST }
	Address types. More...
enum	fip_prefixstate_t { PREFIX_UNUSED = 0, PREFIX_USED }
	State of prefix in use on an interface. More...
enum	fip_routestate_t { ROUTE_UNUSED = 0, ROUTE_USED }
	State of route in use on an interface. More...
enum	fip_addrstate_t {   ADDR_UNUSED = 0, ADDR_NEW, ADDR_TENATIVE, ADDR_OPTIMISTIC,   ADDR_PREFERRED, ADDR_DEPRECATED, ADDR_DUPLICATE, ADDR_DELETE }
	State of address in use on an interface. More...

---

Typedef Documentation

typedef bool fip_bool_t

Typedef the C99 bool type.

Done in a typedef in case your compiler is not C99 compliant

---

Enumeration Type Documentation

enum fip_addrstate_t

State of address in use on an interface.

Note this does NOT map directly to uIP's address states (ADDR_TENATIVE, etc) as this enumeration adds an 'unused' state.

Enumerator:

ADDR_UNUSED	Adddress not used.
ADDR_NEW	New address, DAD may be required before can be used.
ADDR_TENATIVE	Address tenative, waiting for DAD to finish.
ADDR_OPTIMISTIC	Address has optimistically been assigned.
ADDR_PREFERRED	Preferred address to use.
ADDR_DEPRECATED	Address deprecated, probably as it expired.
ADDR_DUPLICATE	Duplicate address, do not use.
ADDR_DELETE	Address being deleted.

enum fip_addrtype_t

Address types.

Note these correspond to uIP's ADDR_ANYTYPE, ADDR_AUTCONF, ADDR_DHCP, and ADDR_MANUAL. Thus you can cast between code using fip_addrtype_t and code using uint8_t with uIP's defines.

Enumerator:

ADDR_UNKNOWN	Unknown address type.
ADDR_AUTOCONF	Autoconfigured address type.
ADDR_STATEFUL	Statefully assigned (ie: DHCP).
ADDR_MANUAL	Manually assigned.
ADDR_MULTICAST	Multicast.

enum fip_prefixstate_t

State of prefix in use on an interface.

Enumerator:

PREFIX_UNUSED	Prefix not used.
PREFIX_USED	Prefix used.

enum fip_return_t

The return value used when functions are only returning a status, and nothing else.

Enumerator:

RV_OK	Everything was OK. RV_OK
RV_UNKNOWN_ERROR	An unknown error occurred. RV_UNKNOWN_ERROR
RV_MEMORY_ERROR	A dynamic memory allocation error occurred, such as malloc failing. RV_MEMORY_ERROR
RV_PARAMETER_ERROR	Parameter passed was invalid. RV_PARAMETER_ERROR
RV_UNHANDLED	Function could not handle request. RV_UNHANDLED
RV_ND6_INVALID_STATE	ND Specific: Invalid State. RV_ND6_INVALID_STATE
RV_ND6_NOENTRY	ND Specific: No Entry. RV_ND6_NOENTRY
RV_RH4_SEGMENT_LEFT_ERROR	There was a problem with the segments left. RV_RH4_SEGMENT_LEFT_ERROR
RV_RH4_HOPS_EXCEEDED	Hop limit exceeded. RV_RH4_HOPS_EXCEEDED
RV_RH4_ADDRESS_OFF_LINK	An address in the source route was not on link. RV_RH4_ADDRESS_OFF_LINK
RV_RH4_PROCESS_NEXT_HEADER	draft-hui-6man-rpl-routing-header-02, page 9, packet has arrived at destination. RV_RH4_PROCESS_NEXT_HEADER
RV_HBH_RPL_INSTANCE_ERROR	Cannot forward packet due to unknown RPL instance ID. RV_HBH_RPL_INSTANCE_ERROR
RV_HBH_RANK_ERROR	Rank error detected, packet dropped. RV_HBH_RANK_ERROR

enum fip_routestate_t

State of route in use on an interface.

Enumerator:

ROUTE_UNUSED	Route not used.
ROUTE_USED	Route used.