Subversion Repositories HelenOS

Rev

Rev 4704 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

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