uIP conversion functions
[The uIP TCP/IP stack]

These functions can be used for converting between different data formats used by uIP. More...

Defines
#define	uip_ipaddr_to_quad(a)
	Convert an IP address to four bytes separated by commas.
#define	uip_ipaddr(addr, addr0, addr1, addr2, addr3)
	Construct an IP address from four bytes.
#define	uip_ip6addr(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7)
	Construct an IPv6 address from eight 16-bit words.
#define	uip_ip6addr_u8(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7, addr8, addr9, addr10, addr11, addr12, addr13, addr14, addr15)
	Construct an IPv6 address from eight 8-bit words.
#define	uip_ipaddr_copy(dest, src) ((dest) = (src))
	Copy an IP address to another IP address.
#define	uip_ipaddr_cmp(addr1, addr2)
	Compare two IP addresses.
#define	uip_ipaddr_maskcmp(addr1, addr2, mask)
	Compare two IP addresses with netmasks.
#define	uip_ipaddr_mask(dest, src, mask)
	Check if an address is a broadcast address for a network.
#define	uip_ipaddr1(addr)
	Pick the first octet of an IP address.
#define	uip_ipaddr2(addr)
	Pick the second octet of an IP address.
#define	uip_ipaddr3(addr)
	Pick the third octet of an IP address.
#define	uip_ipaddr4(addr)
	Pick the fourth octet of an IP address.
#define	UIP_HTONS(n)
	Convert 16-bit quantity from host byte order to network byte order.
Functions
CCIF u16_t	uip_htons (u16_t val)
	Convert 16-bit quantity from host byte order to network byte order.
CCIF int	uiplib_ipaddrconv (const char addrstr, uip_ipaddr_t addr)
	Convert a textual representation of an IP address to a numerical representation.

Detailed Description

These functions can be used for converting between different data formats used by uIP.

Define Documentation

#define UIP_HTONS ( n )

Convert 16-bit quantity from host byte order to network byte order.

This macro is primarily used for converting constants from host byte order to network byte order. For converting variables to network byte order, use the uip_htons() function instead.

Examples:: example-program.c, and example-psock-server.c.

Definition at line 1193 of file uip.h.

Referenced by hc_compress(), hc_inflate(), mac_ethernetToLowpan(), uip_htons(), uip_process(), and uip_udp_new().

#define uip_ip6addr	(	addr,
		addr0,
		addr1,
		addr2,
		addr3,
		addr4,
		addr5,
		addr6,
		addr7	)

Construct an IPv6 address from eight 16-bit words.

This function constructs an IPv6 address.

Definition at line 933 of file uip.h.

Referenced by main().

#define uip_ip6addr_u8	(	addr,
		addr0,
		addr1,
		addr2,
		addr3,
		addr4,
		addr5,
		addr6,
		addr7,
		addr8,
		addr9,
		addr10,
		addr11,
		addr12,
		addr13,
		addr14,
		addr15	)

Construct an IPv6 address from eight 8-bit words.

This function constructs an IPv6 address.

Definition at line 951 of file uip.h.

#define uip_ipaddr	(	addr,
		addr0,
		addr1,
		addr2,
		addr3	)

Construct an IP address from four bytes.

This function constructs an IP address of the type that uIP handles internally from four bytes. The function is handy for specifying IP addresses to use with e.g. the uip_connect() function.

Example:

 uip_ipaddr_t ipaddr;
 struct uip_conn *c;
 
 uip_ipaddr(&ipaddr, 192,168,1,2);
 c = uip_connect(&ipaddr, UIP_HTONS(80));

Parameters:

	addr	A pointer to a uip_ipaddr_t variable that will be filled in with the IP address.
	addr0	The first octet of the IP address.
	addr1	The second octet of the IP address.
	addr2	The third octet of the IP address.
	addr3	The forth octet of the IP address.

Definition at line 919 of file uip.h.

Referenced by main(), and udp_broadcast_new().

#define uip_ipaddr1 ( addr )

Pick the first octet of an IP address.

Picks out the first octet of an IP address.

Example:

 uip_ipaddr_t ipaddr;
 u8_t octet;

 uip_ipaddr(&ipaddr, 1,2,3,4);
 octet = uip_ipaddr1(&ipaddr);

In the example above, the variable "octet" will contain the value 1.

Definition at line 1120 of file uip.h.

#define uip_ipaddr2 ( addr )

Pick the second octet of an IP address.

Picks out the second octet of an IP address.

Example:

 uip_ipaddr_t ipaddr;
 u8_t octet;

 uip_ipaddr(&ipaddr, 1,2,3,4);
 octet = uip_ipaddr2(&ipaddr);

In the example above, the variable "octet" will contain the value 2.

Definition at line 1140 of file uip.h.

#define uip_ipaddr3 ( addr )

Pick the third octet of an IP address.

Picks out the third octet of an IP address.

Example:

 uip_ipaddr_t ipaddr;
 u8_t octet;

 uip_ipaddr(&ipaddr, 1,2,3,4);
 octet = uip_ipaddr3(&ipaddr);

In the example above, the variable "octet" will contain the value 3.

Definition at line 1160 of file uip.h.

#define uip_ipaddr4 ( addr )

Pick the fourth octet of an IP address.

Picks out the fourth octet of an IP address.

Example:

 uip_ipaddr_t ipaddr;
 u8_t octet;

 uip_ipaddr(&ipaddr, 1,2,3,4);
 octet = uip_ipaddr4(&ipaddr);

In the example above, the variable "octet" will contain the value 4.

Definition at line 1180 of file uip.h.

#define uip_ipaddr_cmp	(	addr1,
		addr2		)

Compare two IP addresses.

Compares two IP addresses.

Example:

 uip_ipaddr_t ipaddr1, ipaddr2;

 uip_ipaddr(&ipaddr1, 192,16,1,2);
 if(uip_ipaddr_cmp(&ipaddr2, &ipaddr1)) {
 printf("They are the same");
 }

Parameters:

	addr1	The first IP address.
	addr2	The second IP address.

Definition at line 1014 of file uip.h.

Referenced by hc_compress(), mac_LowpanToEthernet(), and uip_process().

#define uip_ipaddr_copy	(	dest,
		src		)	((dest) = (src))

Copy an IP address to another IP address.

Copies an IP address from one place to another.

Example:

 uip_ipaddr_t ipaddr1, ipaddr2;

 uip_ipaddr(&ipaddr1, 192,16,1,2);
 uip_ipaddr_copy(&ipaddr2, &ipaddr1);

Parameters:

	dest	The destination for the copy.
	src	The source from where to copy.

Definition at line 990 of file uip.h.

Referenced by hc_compress(), hc_inflate(), mac_ethernetToLowpan(), main(), resolv_conf(), uip_nd6_ns_input(), uip_nd6_ns_output(), uip_nd6_ra_input(), uip_process(), and uip_udp_new().

#define uip_ipaddr_mask	(	dest,
		src,
		mask	)

Check if an address is a broadcast address for a network.

Checks if an address is the broadcast address for a network. The network is defined by an IP address that is on the network and the network's netmask.

Parameters:

	addr	The IP address.
	netaddr	The network's IP address.
	netmask	The network's netmask. Mask out the network part of an IP address.

Masks out the network part of an IP address, given the address and the netmask.

Example:

 uip_ipaddr_t ipaddr1, ipaddr2, netmask;

 uip_ipaddr(&ipaddr1, 192,16,1,2);
 uip_ipaddr(&netmask, 255,255,255,0);
 uip_ipaddr_mask(&ipaddr2, &ipaddr1, &netmask);

In the example above, the variable "ipaddr2" will contain the IP address 192.168.1.0.

Parameters:

	dest	Where the result is to be placed.
	src	The IP address.
	mask	The netmask.

Definition at line 1097 of file uip.h.

#define uip_ipaddr_maskcmp	(	addr1,
		addr2,
		mask	)

Compare two IP addresses with netmasks.

Compares two IP addresses with netmasks. The masks are used to mask out the bits that are to be compared.

Example:

 uip_ipaddr_t ipaddr1, ipaddr2, mask;

 uip_ipaddr(&mask, 255,255,255,0);
 uip_ipaddr(&ipaddr1, 192,16,1,2);
 uip_ipaddr(&ipaddr2, 192,16,1,3);
 if(uip_ipaddr_maskcmp(&ipaddr1, &ipaddr2, &mask)) {
 printf("They are the same");
 }

Parameters:

	addr1	The first IP address.
	addr2	The second IP address.
	mask	The netmask.

Definition at line 1045 of file uip.h.

#define uip_ipaddr_to_quad ( a )

Convert an IP address to four bytes separated by commas.

Example:

 uip_ipaddr_t ipaddr;
 printf("ipaddr=%d.%d.%d.%d\n", uip_ipaddr_to_quad(&ipaddr));

Parameters:

a

A pointer to a uip_ipaddr_t.

Definition at line 891 of file uip.h.

Referenced by main(), and uip_log().

Function Documentation

CCIF u16_t uip_htons ( u16_t val )

Convert 16-bit quantity from host byte order to network byte order.

This function is primarily used for converting variables from host byte order to network byte order. For converting constants to network byte order, use the UIP_HTONS() macro instead.

Definition at line 1942 of file uip.c.

References UIP_HTONS.

Referenced by hc_compress(), mac_LowpanToEthernet(), uip_chksum(), uip_ipchksum(), and uip_udp_new().

CCIF int uiplib_ipaddrconv	(	const char *	addrstr,
		uip_ipaddr_t *	addr
	)

Convert a textual representation of an IP address to a numerical representation.

This function takes a textual representation of an IP address in the form a.b.c.d for IPv4 or a:b:c:d:e:f:g:h for IPv6 and converts it into a numeric IP address representation that can be used by other uIP functions.

Parameters:

	addrstr	A pointer to a string containing the IP address in textual form.
	addr	A pointer to a uip_ipaddr_t that will be filled in with the numerical representation of the address.

Return values:

	0	If the IP address could not be parsed.
	Non-zero	If the IP address was parsed.

Definition at line 46 of file uiplib.c.

uIP conversion functions [The uIP TCP/IP stack]

Defines

Functions

Detailed Description

Define Documentation

Function Documentation

uIP conversion functions
[The uIP TCP/IP stack]