Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
uIP conversion functions

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

Macros

#define UIP_HTONL(n)   (n)
 
#define UIP_HTONS(n)
 Convert 16-bit quantity from host byte order to network byte order. More...
 
#define uip_ip4addr_cmp(addr1, addr2)
 Compare two IP addresses. More...
 
#define uip_ip4addr_copy(dest, src)   (*(dest) = *(src))
 
#define uip_ip6addr(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7)
 Construct an IPv6 address from eight 16-bit words. More...
 
#define uip_ip6addr_cmp(addr1, addr2)   (memcmp(addr1, addr2, sizeof(uip_ip6addr_t)) == 0)
 
#define uip_ip6addr_copy(dest, src)   (*(dest) = *(src))
 
#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 sixteen 8-bit words. More...
 
#define uip_ipaddr(addr, addr0, addr1, addr2, addr3)
 Construct an IP address from four bytes. More...
 
#define uip_ipaddr1(addr)
 Pick the first octet of an IP address. More...
 
#define uip_ipaddr2(addr)
 Pick the second octet of an IP address. More...
 
#define uip_ipaddr3(addr)
 Pick the third octet of an IP address. More...
 
#define uip_ipaddr4(addr)
 Pick the fourth octet of an IP address. More...
 
#define uip_ipaddr_cmp(addr1, addr2)   uip_ip6addr_cmp(addr1, addr2)
 
#define uip_ipaddr_copy(dest, src)
 Copy an IP address from one place to another. More...
 
#define uip_ipaddr_mask(dest, src, mask)
 Check if an address is a broadcast address for a network. More...
 
#define uip_ipaddr_maskcmp(addr1, addr2, mask)
 Compare two IP addresses with netmasks. More...
 
#define uip_ipaddr_prefixcmp(addr1, addr2, length)   (memcmp(addr1, addr2, length>>3) == 0)
 
#define uip_ipaddr_to_quad(a)
 Convert an IP address to four bytes separated by commas. More...
 
#define uip_ntohl   uip_htonl
 
#define uip_ntohs   uip_htons
 
#define uiplib_ipaddrconv   uiplib_ip6addrconv
 Convert a textual representation of an IP address to a numerical representation. More...
 

Functions

CCIF uint32_t uip_htonl (uint32_t val)
 
CCIF uint16_t uip_htons (uint16_t val)
 Convert a 16-bit quantity from host byte order to network byte order. More...
 
CCIF int uiplib_ip4addrconv (const char *addrstr, uip_ip4addr_t *addr)
 
CCIF int uiplib_ip6addrconv (const char *addrstr, uip_ip6addr_t *addr)
 

#define UIP_HTONL (   n)    (n)

Referenced by send_rrep(), and uip_htonl().

#define uip_ip4addr_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
addr1The first IP address.
addr2The second IP address.

Referenced by arp_update(), ip64_4to6(), ip64_6to4(), ip64_addrmap_lookup(), ip64_arp_arp_input(), ip64_arp_check_cache(), ip64_arp_create_ethhdr(), and ip64_arp_timer().

#define uip_ip4addr_copy (   dest,
  src 
)    (*(dest) = *(src))
#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.

Referenced by create_rpl_dag(), main(), rpl_link_neighbor_callback(), set_global_address(), simple_rpl_init_dag_immediately(), and uncompress_hdr_hc1().

#define uip_ip6addr_cmp (   addr1,
  addr2 
)    (memcmp(addr1, addr2, sizeof(uip_ip6addr_t)) == 0)

Referenced by ip64_addrmap_lookup().

#define uip_ip6addr_copy (   dest,
  src 
)    (*(dest) = *(src))

Referenced by ip64_addrmap_create().

#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 sixteen 8-bit words.

This function constructs an IPv6 address.

#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:

struct uip_conn *c;
uip_ipaddr(&ipaddr, 192,168,1,2);
c = uip_connect(&ipaddr, UIP_HTONS(80));
Parameters
addrA pointer to a uip_ipaddr_t variable that will be filled in with the IP address.
addr0The first octet of the IP address.
addr1The second octet of the IP address.
addr2The third octet of the IP address.
addr3The forth octet of the IP address.

Referenced by dhcpc_init(), dhcpc_request(), ip64_arp_check_cache(), ip64_arp_create_ethhdr(), ip64_dhcpc_init(), ip64_dhcpc_request(), and ip64_init().

#define uip_ipaddr1 (   addr)

Pick the first octet of an IP address.

Picks out the first octet of an IP address.

Example:

uint8_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.

#define uip_ipaddr2 (   addr)

Pick the second octet of an IP address.

Picks out the second octet of an IP address.

Example:

uint8_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.

#define uip_ipaddr3 (   addr)

Pick the third octet of an IP address.

Picks out the third octet of an IP address.

Example:

uint8_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.

#define uip_ipaddr4 (   addr)

Pick the fourth octet of an IP address.

Picks out the fourth octet of an IP address.

Example:

uint8_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.

#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
addrThe IP address.
netaddrThe network's IP address.
netmaskThe 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
destWhere the result is to be placed.
srcThe IP address.
maskThe netmask.
#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
addr1The first IP address.
addr2The second IP address.
maskThe netmask.

Referenced by ip64_4to6(), ip64_arp_check_cache(), ip64_arp_create_arp_request(), ip64_arp_create_ethhdr(), recv_data(), uip_arp_out(), and uip_over_mesh_send().

#define uip_ipaddr_prefixcmp (   addr1,
  addr2,
  length 
)    (memcmp(addr1, addr2, length>>3) == 0)
#define uip_ipaddr_to_quad (   a)

Convert an IP address to four bytes separated by commas.

Example:

printf("ipaddr=%d.%d.%d.%d\n", uip_ipaddr_to_quad(&ipaddr));
Parameters
aA pointer to a uip_ipaddr_t.

Referenced by handle_incoming_rerr(), handle_incoming_rrep(), handle_incoming_rreq(), httpd_sprint_ip4(), ip64_4to6(), ip64_arp_check_cache(), send_rerr(), send_rrep(), send_rreq(), and uip_over_mesh_send().

#define uip_ntohs   uip_htons
#define uiplib_ipaddrconv   uiplib_ip6addrconv

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
addrstrA pointer to a string containing the IP address in textual form.
addrA pointer to a uip_ip4addr_t that will be filled in with the numerical representation of the address.
Return values
0If the IP address could not be parsed.
Non-zeroIf the IP address was parsed.

CCIF uint16_t uip_htons ( uint16_t  val)

Convert a 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.

References UIP_HTONS.

Referenced by appcall(), ip64_4to6(), ip64_6to4(), ip64_addrmap_lookup(), ipv4_checksum(), ipv4_transport_checksum(), ipv6_transport_checksum(), make_tcp_stats(), PROCESS_THREAD(), receiver(), send_msg(), tcp_socket_connect(), tcp_socket_listen(), tcp_socket_unlisten(), uip_chksum(), uip_ipchksum(), upper_layer_chksum(), and websocket_http_client_get().

CCIF int uiplib_ip4addrconv ( const char *  addrstr,
uip_ip4addr_t addr 
)
CCIF int uiplib_ip6addrconv ( const char *  addrstr,
uip_ip6addr_t addr 
)