docs/user_manual/chap_api_ipv4.tex

9 The result is stored in the char array that ipbuf points to. The given IP address argument must be in network order (i.e. 0xC0A80101 becomes 192.168.1.1).
24 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
41 Convert the IPv4 dotted-decimal notation into binary form. The result is stored in the
42 \texttt{int} that IP points to. Little endian or big endian is not taken into account.
59 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
88 On success, this call returns the netmask in CIDR notation is returned if the netmask is valid.
89 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
102 \subsection{pico$\_$ipv4$\_$is$\_$unicast}
105 Check if the provided address is unicast or multicast.
147 If the source can not be found, \texttt{NULL} is returned and \texttt{pico$\_$err} is set appropriately.
152 \item \texttt{PICO$\_$ERR$\_$EHOSTUNREACH} - host is unreachable
183 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
190 \item \texttt{PICO$\_$ERR$\_$EHOSTUNREACH} - host is unreachable
218 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
249 On error, \texttt{NULL} is returned and \texttt{pico$\_$err} is set appropriately.
271 which is used as a gateway for the internal hosts.
285 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
351 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
385 \item \texttt{link} - Local device interface. If a valid gateway is specified, this parameter is not mandatory, otherwise \texttt{NULL} can be used.
389 On success, this call returns 0. On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
396 \item \texttt{PICO$\_$ERR$\_$EHOSTUNREACH} - host is unreachable
428 On success, this call returns 0 if the route is found.
429 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
459 On success the gateway address is returned.
460 On error a \texttt{null} address is returned (\texttt{0.0.0.0}) and \texttt{pico$\_$err} is set appropriately.
465 \item \texttt{PICO$\_$ERR$\_$EHOSTUNREACH} - host is unreachable
478 The information from the replies is passed to the callback function after a succesfull reception.
479 If a timeout expires before a reply is received, the callback is called with the error condition.
518 On success, this call returns a positive number, which is the ID of the ping operation just started.
519 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.
545     \item \texttt{id} - identification number for the ping operation. This has been returned by \texttt{pico$\_$icmp4$\_$ping()} and it is intended to distinguish the operation to be cancelled.
550 On error, -1 is returned and \texttt{pico$\_$err} is set appropriately.