WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/include/inet.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup net
 *  @{
 */
 
/** @file
 *  Internet common definitions.
 */
 
#ifndef __NET_INET_H__
#define __NET_INET_H__
 
#include <sys/types.h>
 
#include "byteorder.h"
 
/** Type definition of the socket address.
 *  @see sockaddr
 */
typedef struct sockaddr     sockaddr_t;
 
/** Type definition of the address information.
 *  @see addrinfo
 */
typedef struct addrinfo     addrinfo_t;
 
/** Prints the address into the character buffer.
 *  @param[in] family The address family.
 *  @param[in] data The address data.
 *  @param[out] address The character buffer to be filled.
 *  @param[in] length The buffer length.
 *  @returns EOK on success.
 *  @returns EINVAL if the data or address parameter is NULL.
 *  @returns ENOMEM if the character buffer is not long enough.
 *  @returns ENOTSUP if the address family is not supported.
 */
int inet_ntop( uint16_t family, const uint8_t * data, char * address, size_t length );
 
/** Parses the character string into the address.
 *  If the string is shorter than the full address, zero bytes are added.
 *  @param[in] family The address family.
 *  @param[in] address The character buffer to be parsed.
 *  @param[out] data The address data to be filled.
 *  @returns EOK on success.
 *  @returns EINVAL if the data parameter is NULL.
 *  @returns ENOENT if the address parameter is NULL.
 *  @returns ENOTSUP if the address family is not supported.
 */
int inet_pton( uint16_t family, const char * address, uint8_t * data );
 
/** Socket address.
 */
struct sockaddr{
    /** Address family.
     *  @see socket.h
     */
    uint16_t        sa_family;
    /** 14 byte protocol address.
     */
    uint8_t         sa_data[ 14 ];
};
 
// TODO define address information
// /** Address information.
// * \todo
// */
//struct addrinfo{
//  int             ai_flags;       // AI_PASSIVE, AI_CANONNAME, etc.
//  uint16_t        ai_family;      // AF_INET, AF_INET6, AF_UNSPEC
//  int             ai_socktype;    // SOCK_STREAM, SOCK_DGRAM
//  int             ai_protocol;    // use 0 for "any"
//  size_t          ai_addrlen;     // size of ai_addr in bytes
//  struct sockaddr *   ai_addr;    // struct sockaddr_in or _in6
//  char *          ai_canonname;   // full canonical hostname
//  struct addrinfo *   ai_next;    // linked list, next node
//};
 
/*int getaddrinfo(const char *node, // e.g. "www.example.com" or IP
const char *service, // e.g. "http" or port number
const struct addrinfo *hints,
struct addrinfo **res);
 
getnameinfo
*/
 
#endif
 
/** @}
 */
 

Rev 4704	Rev 4756
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup net	29	/** @addtogroup net
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* Internet common definitions.	34	* Internet common definitions.
35	*/	35	*/
36		36
37	#ifndef __NET_INET_H__	37	#ifndef __NET_INET_H__
38	#define __NET_INET_H__	38	#define __NET_INET_H__
39		39
40	#include <sys/types.h>	40	#include <sys/types.h>
41		41
42	#include "byteorder.h"	42	#include "byteorder.h"
43		43
44	/** Type definition of the socket address.	44	/** Type definition of the socket address.
45	* @see sockaddr	45	* @see sockaddr
46	*/	46	*/
47	typedef struct sockaddr sockaddr_t;	47	typedef struct sockaddr sockaddr_t;
48		48
49	/** Type definition of the address information.	49	/** Type definition of the address information.
50	* @see addrinfo	50	* @see addrinfo
51	*/	51	*/
52	typedef struct addrinfo addrinfo_t;	52	typedef struct addrinfo addrinfo_t;
53		53
54	/** Prints the address into the character buffer.	54	/** Prints the address into the character buffer.
55	* @param family The address family. Input parameter.	55	* @param[in] family The address family.
56	* @param data The address data. Input parameter.	56	* @param[in] data The address data.
57	* @param address The character buffer to be filled. Output parameter.	57	* @param[out] address The character buffer to be filled.
58	* @param length The buffer length. Input parameter.	58	* @param[in] length The buffer length.
59	* @returns EOK on success.	59	* @returns EOK on success.
60	* @returns EINVAL if the data or address parameter is NULL.	60	* @returns EINVAL if the data or address parameter is NULL.
61	* @returns ENOMEM if the character buffer is not long enough.	61	* @returns ENOMEM if the character buffer is not long enough.
62	* @returns ENOTSUP if the address family is not supported.	62	* @returns ENOTSUP if the address family is not supported.
63	*/	63	*/
64	int inet_ntop( uint16_t family, const uint8_t * data, char * address, size_t length );	64	int inet_ntop( uint16_t family, const uint8_t * data, char * address, size_t length );
65		65
66	/** Parses the character string into the address.	66	/** Parses the character string into the address.
67	* If the string is shorter than the full address, zero bytes are added.	67	* If the string is shorter than the full address, zero bytes are added.
68	* @param family The address family. Input parameter.	68	* @param[in] family The address family.
69	* @param address The character buffer to be parsed. Input parameter.	69	* @param[in] address The character buffer to be parsed.
70	* @param data The address data to be filled. Output parameter.	70	* @param[out] data The address data to be filled.
71	* @returns EOK on success.	71	* @returns EOK on success.
72	* @returns EINVAL if the data parameter is NULL.	72	* @returns EINVAL if the data parameter is NULL.
73	* @returns ENOENT if the address parameter is NULL.	73	* @returns ENOENT if the address parameter is NULL.
74	* @returns ENOTSUP if the address family is not supported.	74	* @returns ENOTSUP if the address family is not supported.
75	*/	75	*/
76	int inet_pton( uint16_t family, const char * address, uint8_t * data );	76	int inet_pton( uint16_t family, const char * address, uint8_t * data );
77		77
78	/** Socket address.	78	/** Socket address.
79	*/	79	*/
80	struct sockaddr{	80	struct sockaddr{
81	/** Address family.	81	/** Address family.
82	* @see socket.h	82	* @see socket.h
83	*/	83	*/
84	uint16_t sa_family;	84	uint16_t sa_family;
85	/** 14 byte protocol address.	85	/** 14 byte protocol address.
86	*/	86	*/
87	uint8_t sa_data[ 14 ];	87	uint8_t sa_data[ 14 ];
88	};	88	};
89		89
-		90	// TODO define address information
90	/** Address information.	91	// /** Address information.
91	* \todo	92	// * \todo
92	*/	93	// */
93	struct addrinfo{	94	//struct addrinfo{
94	int ai_flags; // AI_PASSIVE, AI_CANONNAME, etc.	95	// int ai_flags; // AI_PASSIVE, AI_CANONNAME, etc.
95	uint16_t ai_family; // AF_INET, AF_INET6, AF_UNSPEC	96	// uint16_t ai_family; // AF_INET, AF_INET6, AF_UNSPEC
96	int ai_socktype; // SOCK_STREAM, SOCK_DGRAM	97	// int ai_socktype; // SOCK_STREAM, SOCK_DGRAM
97	int ai_protocol; // use 0 for "any"	98	// int ai_protocol; // use 0 for "any"
98	size_t ai_addrlen; // size of ai_addr in bytes	99	// size_t ai_addrlen; // size of ai_addr in bytes
99	struct sockaddr * ai_addr; // struct sockaddr_in or _in6	100	// struct sockaddr * ai_addr; // struct sockaddr_in or _in6
100	char * ai_canonname; // full canonical hostname	101	// char * ai_canonname; // full canonical hostname
101	struct addrinfo * ai_next; // linked list, next node	102	// struct addrinfo * ai_next; // linked list, next node
102	};	103	//};
103		104
104	/int getaddrinfo(const char node, // e.g. "www.example.com" or IP	105	/int getaddrinfo(const char node, // e.g. "www.example.com" or IP
105	const char *service, // e.g. "http" or port number	106	const char *service, // e.g. "http" or port number
106	const struct addrinfo *hints,	107	const struct addrinfo *hints,
107	struct addrinfo **res);	108	struct addrinfo **res);
108		-
109	getnameinfo	109	getnameinfo
110	*/	110	*/
111		111
112	#endif	112	#endif
113		113
114	/** @}	114	/** @}
115	*/	115	*/
116		116

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/inet.h – Rev 4704 → 4756