31,7 → 31,7 |
*/ |
|
/** @file |
* \todo |
* IP client interface. |
*/ |
|
#ifndef __NET_IP_CLIENT_H__ |
45,22 → 45,67 |
#include "ip_interface.h" |
#include "socket_codes.h" |
|
/** Prepares the packet to be transfered via IP. |
* The IP header is prefixed. |
* @param[in,out] packet The packet to be prepared. |
* @param[in] protocol The transport protocol. |
* @param[in] ttl The time to live counter. The IPDEFTTL is set if zero (0). |
* @param[in] tos The type of service. |
* @param[in] dont_fragment The value indicating whether fragmentation is disabled. |
* @param[in] ipopt_length The prefixed IP options length in bytes. |
* @returns EOK on success. |
* @returns ENOMEM if there is not enough memory left in the packet. |
*/ |
int ip_client_prepare_packet( packet_t packet, ip_protocol_t protocol, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, size_t ipopt_length ); |
|
/** Processes the received IP packet. |
* Fills set header fields. |
* Returns the prefixed IP header length. |
* @param[in] packet The received packet. |
* @param[out] protocol The transport protocol. May be NULL if not desired. |
* @param[out] ttl The time to live counter. May be NULL if not desired. |
* @param[out] tos The type of service. May be NULL if not desired. |
* @param[out] dont_fragment The value indicating whether the fragmentation is disabled. May be NULL if not desired. |
* @param[out] ipopt_length The IP options length in bytes. May be NULL if not desired. |
* @returns The prefixed IP header length in bytes on success. |
* @returns ENOMEM if the packet is too short to contain the IP header. |
*/ |
int ip_client_process_packet( packet_t packet, ip_protocol_t * protocol, ip_ttl_t * ttl, ip_tos_t * tos, int * dont_fragment, size_t * ipopt_length ); |
|
/** Returns the IP header length. |
* @param packet The packet. Input parameter. |
* @param[in] packet The packet. |
* @returns The IP header length in bytes. |
* @returns Zero (0) if there is no IP header. |
*/ |
size_t ip_client_header_length( packet_t packet ); |
|
/** \todo |
/** Updates the IPv4 pseudo header data length field. |
* @param[in,out] header The IPv4 pseudo header to be updated. |
* @param[in] headerlen The length of the IP pseudo header in bytes. |
* @param[in] data_length The data length to be set. |
* @returns EOK on success. |
* @returns EBADMEM if the header parameter is NULL. |
* @returns EINVAL if the headerlen parameter is not IPv4 pseudo header length. |
*/ |
int ip_client_set_pseudo_header_data_length( ip_pseudo_header_ref header, size_t headerlen, size_t data_length ); |
|
/** \todo |
/** Constructs the IPv4 pseudo header. |
* @param[in] protocol The transport protocol. |
* @param[in] src The source address. |
* @param[in] srclen The source address length. |
* @param[in] dest The destination address. |
* @param[in] destlen The destination address length. |
* @param[in] data_length The data length to be set. |
* @param[out] header The constructed IPv4 pseudo header. |
* @param[out] headerlen The length of the IP pseudo header in bytes. |
* @returns EOK on success. |
* @returns EBADMEM if the header and/or the headerlen parameter is NULL. |
* @returns EINVAL if the source address and/or the destination address parameter is NULL. |
* @returns EINVAL if the source address length is less than struct sockaddr length. |
* @returns EINVAL if the source address length differs from the destination address length. |
* @returns EINVAL if the source address family differs from the destination family. |
* @returns EAFNOSUPPORT if the address family is not supported. |
* @returns ENOMEM if there is not enough memory left. |
*/ |
int ip_client_get_pseudo_header( ip_protocol_t protocol, struct sockaddr * src, socklen_t srclen, struct sockaddr * dest, socklen_t destlen, size_t data_length, ip_pseudo_header_ref * header, size_t * headerlen ); |
|