Added comments whether fields are host or network byte order (task #1568)

This commit is contained in:
goldsimon
2007-05-17 12:21:32 +00:00
parent 5e9d80fbdb
commit 874415a193
6 changed files with 21 additions and 1 deletions

View File

@@ -241,6 +241,7 @@ lwip_standard_chksum(void *dataptr, int len)
/* inet_chksum_pseudo:
*
* Calculates the pseudo Internet checksum used by TCP and UDP for a pbuf chain.
* IP addresses are expected to be in network byte order.
*/
u16_t

View File

@@ -249,6 +249,8 @@ end:
* @param dst_ip Destination IP address.
* @param dst_port Destination UDP port.
*
* dst_ip & dst_port are expected to be in the same byte order as in the pcb.
*
* If the PCB already has a remote address association, it will
* be restored after the data is sent.
*
@@ -430,6 +432,8 @@ udp_send(struct udp_pcb *pcb, struct pbuf *p)
* bind to all local interfaces.
* @param port local UDP port to bind with.
*
* ipaddr & port are expected to be in the same byte order as in the pcb.
*
* @return lwIP error code.
* - ERR_OK. Successful. No error occured.
* - ERR_USE. The specified ipaddr and port are already bound to by
@@ -528,6 +532,8 @@ udp_bind(struct udp_pcb *pcb, struct ip_addr *ipaddr, u16_t port)
*
* @return lwIP error code
*
* ipaddr & port are expected to be in the same byte order as in the pcb.
*
* @see udp_disconnect()
*/
err_t