ares_data.h

   1
   2 /* Copyright (C) 2009-2010 by Daniel Stenberg
   3  *
   4  * Permission to use, copy, modify, and distribute this
   5  * software and its documentation for any purpose and without
   6  * fee is hereby granted, provided that the above copyright
   7  * notice appear in all copies and that both that copyright
   8  * notice and this permission notice appear in supporting
   9  * documentation, and that the name of M.I.T. not be used in
  10  * advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.
  12  * M.I.T. makes no representations about the suitability of
  13  * this software for any purpose.  It is provided "as is"
  14  * without express or implied warranty.
  15  */
  16
  17 typedef enum {
  18   ARES_DATATYPE_UNKNOWN = 1,  /* unknown data type     - introduced in 1.7.0 */
  19   ARES_DATATYPE_SRV_REPLY,    /* struct ares_srv_reply - introduced in 1.7.0 */
  20   ARES_DATATYPE_TXT_REPLY,    /* struct ares_txt_reply - introduced in 1.7.0 */
  21   ARES_DATATYPE_ADDR_NODE,    /* struct ares_addr_node - introduced in 1.7.1 */
  22 #if 0
  23   ARES_DATATYPE_ADDR6TTL,     /* struct ares_addrttl   */
  24   ARES_DATATYPE_ADDRTTL,      /* struct ares_addr6ttl  */
  25   ARES_DATATYPE_HOSTENT,      /* struct hostent        */
  26   ARES_DATATYPE_OPTIONS,      /* struct ares_options   */
  27 #endif
  28   ARES_DATATYPE_LAST          /* not used              - introduced in 1.7.0 */
  29 } ares_datatype;
  30
  31 #define ARES_DATATYPE_MARK 0xbead
  32
  33 /*
  34  * ares_data struct definition is internal to c-ares and shall not
  35  * be exposed by the public API in order to allow future changes
  36  * and extensions to it without breaking ABI.  This will be used
  37  * internally by c-ares as the container of multiple types of data
  38  * dynamically allocated for which a reference will be returned
  39  * to the calling application.
  40  *
  41  * c-ares API functions returning a pointer to c-ares internally
  42  * allocated data will actually be returning an interior pointer
  43  * into this ares_data struct.
  44  *
  45  * All this is 'invisible' to the calling application, the only
  46  * requirement is that this kind of data must be free'ed by the
  47  * calling application using ares_free_data() with the pointer
  48  * it has received from a previous c-ares function call.
  49  */
  50
  51 struct ares_data {
  52   ares_datatype type;  /* Actual data type identifier. */
  53   unsigned int  mark;  /* Private ares_data signature. */
  54   union {
  55     struct ares_txt_reply txt_reply;
  56     struct ares_srv_reply srv_reply;
  57     struct ares_addr_node addr_node;
  58   } data;
  59 };
  60
  61 void *ares_malloc_data(ares_datatype type);
  62
  63 ares_datatype ares_get_datatype(void * dataptr);