/usr/include/gwenhywfar4/gwenhywfar/inetaddr.h is in libgwenhywfar-core-dev 4.15.3-5+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | /***************************************************************************
$RCSfile$
-------------------
cvs : $Id$
begin : Tue Oct 02 2002
copyright : (C) 2002 by Martin Preuss
email : martin@libchipcard.de
***************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
* MA 02111-1307 USA *
* *
***************************************************************************/
/**
* @file inetaddr.h
* @short This file contains the internet address handling module
*/
#ifndef GWEN_INETADDR_H
#define GWEN_INETADDR_H
#include <gwenhywfar/gwenhywfarapi.h>
#include "gwenhywfar/error.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup MOD_INETADDR Internet Address Module
* @ingroup MOD_OS
* @short This module handles internet addresses
*
* This module allows using of internet IP addresses. It is also capable of
* resolving addresses and hostnames.
* @author Martin Preuss<martin@libchipcard.de>
*/
/*@{*/
/** @name Error Codes */
/*@{*/
#define GWEN_INETADDR_ERROR_TYPE "InetAddr"
#define GWEN_INETADDR_ERROR_MEMORY_FULL 1
#define GWEN_INETADDR_ERROR_BAD_ADDRESS 2
#define GWEN_INETADDR_ERROR_BUFFER_OVERFLOW 3
#define GWEN_INETADDR_ERROR_HOST_NOT_FOUND 4
#define GWEN_INETADDR_ERROR_NO_ADDRESS 5
#define GWEN_INETADDR_ERROR_NO_RECOVERY 6
#define GWEN_INETADDR_ERROR_TRY_AGAIN 7
#define GWEN_INETADDR_ERROR_UNKNOWN_DNS_ERROR 8
#define GWEN_INETADDR_ERROR_BAD_ADDRESS_FAMILY 9
#define GWEN_INETADDR_ERROR_UNSUPPORTED 10
/*@}*/
/** @name Capabilities of this module
*
*/
/*@{*/
#define GWEN_INETADDR_CAPS_AF_TCP 0x00000001
#define GWEN_INETADDR_CAPS_AF_UNIX 0x00000002
GWENHYWFAR_API uint32_t GWEN_InetAddr_GetCapabilities(void);
/*@}*/
/**
* Address family (in most cases this is AddressFamilyIP)
*/
typedef enum {
/** Internet Protocol (IP) */
GWEN_AddressFamilyIP=0,
/* Unix Domain Socket */
GWEN_AddressFamilyUnix
} GWEN_AddressFamily;
/**
* You shoukd treat this type as opaque. Its members are not part of the API,
* i.e. they are subject to changes without notice !
*/
typedef struct GWEN_INETADDRESSSTRUCT GWEN_INETADDRESS;
/**
* @name Construction and destruction
*
* These functions allocate and free administrative data about IP addresses.
*/
/*@{*/
GWENHYWFAR_API GWEN_INETADDRESS *GWEN_InetAddr_new(GWEN_AddressFamily af);
GWENHYWFAR_API void GWEN_InetAddr_free(GWEN_INETADDRESS *ia);
GWENHYWFAR_API GWEN_INETADDRESS *GWEN_InetAddr_dup(const GWEN_INETADDRESS *ia);
/*@}*/
/**
* @name Get and set address
*
* These functions allow getting and setting of IP addresses either by
* hostname or host address.
*/
/*@{*/
/**
* Sets the IP address.
* @return error code
* @param ia INETADDRESS to manipulate
* @param addr IP address in 3-dot-notation ("1.2.3.4")
*/
GWENHYWFAR_API int GWEN_InetAddr_SetAddress(GWEN_INETADDRESS *ia, const char *addr);
/**
* Sets the IP name and resolves its address.
* @return error code
* @param ia INETADDRESS to manipulate
* @param name hostname whose address is to be resolved in 3-dot-notation
*/
GWENHYWFAR_API int GWEN_InetAddr_SetName(GWEN_INETADDRESS *ia, const char *name);
/**
* Gets the IP address stored in the INETADDRESS.
* @return error code
* @param ia INETADDRESS to use
* @param buffer pointer to a buffer to receive the address
* @param bsize size of the buffer in bytes
*/
GWENHYWFAR_API
int GWEN_InetAddr_GetAddress(const GWEN_INETADDRESS *ia,
char *buffer, unsigned int bsize);
/**
* Gets the host name stored in the INETADDRESS. If there is none, then the
* IP address stored in the INETADDRESS will be used to resolve the hostname.
* @return error code
* @param ia INETADDRESS to use
* @param buffer pointer to a buffer to receive the name
* @param bsize size of the buffer in bytes
*/
GWENHYWFAR_API
int GWEN_InetAddr_GetName(const GWEN_INETADDRESS *ia,
char *buffer, unsigned int bsize);
/*@}*/
/**
* @name Get and set port
*
* These functions allow getting and setting of the port.
*/
/*@{*/
/**
* Return the port stored in the INETADDRESS
* @param ia INETADDRESS to use
*/
GWENHYWFAR_API int GWEN_InetAddr_GetPort(const GWEN_INETADDRESS *ia);
/**
* Set the port in the given INETADDRESS.
* @return error code
* @param ia INETADDRESS to manipulate
* @param port port to set (0-65535)
*/
GWENHYWFAR_API int GWEN_InetAddr_SetPort(GWEN_INETADDRESS *ia,
int port);
/*@}*/
#ifdef __cplusplus
}
#endif
/*@} defgroup */
#endif /* GWEN_INETADDR_H */
|