|
Defines | |
| #define | uip_ipaddr(addr, addr0, addr1, addr2, addr3) |
| #define | uip_ip6addr(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7) |
| #define | uip_ipaddr_copy(dest, src) |
| #define | uip_ipaddr_cmp(addr1, addr2) |
| #define | uip_ipaddr_maskcmp(addr1, addr2, mask) |
| #define | uip_ipaddr_mask(dest, src, mask) |
| #define | uip_ipaddr1(addr) |
| #define | uip_ipaddr2(addr) |
| #define | uip_ipaddr3(addr) |
| #define | uip_ipaddr4(addr) |
| #define | HTONS(n) |
| #define | ntohs htons |
Functions | |
| u16_t | htons (u16_t val) |
| unsigned char | uiplib_ipaddrconv (char *addrstr, unsigned char *addr) |
Detailed Description
These functions can be used for converting between different data formats used by uIP.
Define Documentation
| #define HTONS | ( | n | ) |
| #define uip_ip6addr | ( | addr, | ||
| addr0, | ||||
| addr1, | ||||
| addr2, | ||||
| addr3, | ||||
| addr4, | ||||
| addr5, | ||||
| addr6, | ||||
| addr7 | ||||
| ) |
| #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, 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.
| #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.
| #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.
| #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.
| #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.
| #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.
| #define uip_ipaddr_copy | ( | 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.
| #define uip_ipaddr_mask | ( | dest, | ||
| src, | ||||
| mask | ||||
| ) |
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.
| #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.
Function Documentation
| unsigned char uiplib_ipaddrconv | ( | char * | addrstr, | |
| unsigned char * | 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 and converts it into a 4-byte array 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 4-byte array 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.
