Subversion Repositories HelenOS

Rev

Rev 4722 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4722 Rev 4756
Line 29... Line 29...
29 
/** @addtogroup ip
 29 
/** @addtogroup ip
30 
 *  @{
 30 
 *  @{
31 
 */
 31 
 */
32 
 
 32 
 
33 
/** @file
 33 
/** @file
34 
 *  \todo
 34 
 *  IP client interface.
35 
 */
 35 
 */
36 
 
 36 
 
37 
#ifndef __NET_IP_CLIENT_H__
 37 
#ifndef __NET_IP_CLIENT_H__
38 
#define __NET_IP_CLIENT_H__
 38 
#define __NET_IP_CLIENT_H__
39 
 
 39 
 
Line 43... Line 43...
43 
 
 43 
 
44 
#include "ip_codes.h"
 44 
#include "ip_codes.h"
45 
#include "ip_interface.h"
 45 
#include "ip_interface.h"
46 
#include "socket_codes.h"
 46 
#include "socket_codes.h"
47 
 
 47 
 
- 
 
 48 
/** Prepares the packet to be transfered via IP.
- 
 
 49 
 *  The IP header is prefixed.
- 
 
 50 
 *  @param[in,out] packet The packet to be prepared.
- 
 
 51 
 *  @param[in] protocol The transport protocol.
- 
 
 52 
 *  @param[in] ttl The time to live counter. The IPDEFTTL is set if zero (0).
- 
 
 53 
 *  @param[in] tos The type of service.
- 
 
 54 
 *  @param[in] dont_fragment The value indicating whether fragmentation is disabled.
- 
 
 55 
 *  @param[in] ipopt_length The prefixed IP options length in bytes.
- 
 
 56 
 *  @returns EOK on success.
- 
 
 57 
 *  @returns ENOMEM if there is not enough memory left in the packet.
- 
 
 58 
 */
48 
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 );
 59 
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 );
49 
 
 60 
 
- 
 
 61 
/** Processes the received IP packet.
- 
 
 62 
 *  Fills set header fields.
- 
 
 63 
 *  Returns the prefixed IP header length.
- 
 
 64 
 *  @param[in] packet The received packet.
- 
 
 65 
 *  @param[out] protocol The transport protocol. May be NULL if not desired.
- 
 
 66 
 *  @param[out] ttl The time to live counter. May be NULL if not desired.
- 
 
 67 
 *  @param[out] tos The type of service. May be NULL if not desired.
- 
 
 68 
 *  @param[out] dont_fragment The value indicating whether the fragmentation is disabled. May be NULL if not desired.
- 
 
 69 
 *  @param[out] ipopt_length The IP options length in bytes. May be NULL if not desired.
- 
 
 70 
 *  @returns The prefixed IP header length in bytes on success.
- 
 
 71 
 *  @returns ENOMEM if the packet is too short to contain the IP header.
- 
 
 72 
 */
50 
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 );
 73 
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 );
51 
 
 74 
 
52 
/** Returns the IP header length.
 75 
/** Returns the IP header length.
53 
 *  @param packet The packet. Input parameter.
 76 
 *  @param[in] packet The packet.
54 
 *  @returns The IP header length in bytes.
 77 
 *  @returns The IP header length in bytes.
55 
 *  @returns Zero (0) if there is no IP header.
 78 
 *  @returns Zero (0) if there is no IP header.
56 
 */
 79 
 */
57 
size_t  ip_client_header_length( packet_t packet );
 80 
size_t  ip_client_header_length( packet_t packet );
58 
 
 81 
 
- 
 
 82 
/** Updates the IPv4 pseudo header data length field.
- 
 
 83 
 *  @param[in,out] header The IPv4 pseudo header to be updated.
- 
 
 84 
 *  @param[in] headerlen The length of the IP pseudo header in bytes.
- 
 
 85 
 *  @param[in] data_length The data length to be set.
59 
/** \todo
 86 
 *  @returns EOK on success.
- 
 
 87 
 *  @returns EBADMEM if the header parameter is NULL.
- 
 
 88 
 *  @returns EINVAL if the headerlen parameter is not IPv4 pseudo header length.
60 
 */
 89 
 */
61 
int ip_client_set_pseudo_header_data_length( ip_pseudo_header_ref header, size_t headerlen, size_t data_length );
 90 
int ip_client_set_pseudo_header_data_length( ip_pseudo_header_ref header, size_t headerlen, size_t data_length );
62 
 
 91 
 
- 
 
 92 
/** Constructs the IPv4 pseudo header.
- 
 
 93 
 *  @param[in] protocol The transport protocol.
- 
 
 94 
 *  @param[in] src The source address.
- 
 
 95 
 *  @param[in] srclen The source address length.
- 
 
 96 
 *  @param[in] dest The destination address.
- 
 
 97 
 *  @param[in] destlen The destination address length.
- 
 
 98 
 *  @param[in] data_length The data length to be set.
- 
 
 99 
 *  @param[out] header The constructed IPv4 pseudo header.
- 
 
 100 
 *  @param[out] headerlen The length of the IP pseudo header in bytes.
63 
/** \todo
 101 
 *  @returns EOK on success.
- 
 
 102 
 *  @returns EBADMEM if the header and/or the headerlen parameter is NULL.
- 
 
 103 
 *  @returns EINVAL if the source address and/or the destination address parameter is NULL.
- 
 
 104 
 *  @returns EINVAL if the source address length is less than struct sockaddr length.
- 
 
 105 
 *  @returns EINVAL if the source address length differs from the destination address length.
- 
 
 106 
 *  @returns EINVAL if the source address family differs from the destination family.
- 
 
 107 
 *  @returns EAFNOSUPPORT if the address family is not supported.
- 
 
 108 
 *  @returns ENOMEM if there is not enough memory left.
64 
 */
 109 
 */
65 
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 );
 110 
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 );
66 
 
 111 
 
67 
// TODO ipopt manipulation
 112 
// TODO ipopt manipulation
68 
 
 113