contrib/bind-9.3/lib/dns/include/dns/rdatatype.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: rdatatype.h,v 1.17.206.1 2004/03/06 08:13:59 marka Exp $ */
  19
  20 #ifndef DNS_RDATATYPE_H
  21 #define DNS_RDATATYPE_H 1
  22
  23 #include <isc/lang.h>
  24
  25 #include <dns/types.h>
  26
  27 ISC_LANG_BEGINDECLS
  28
  29 isc_result_t
  30 dns_rdatatype_fromtext(dns_rdatatype_t *typep, isc_textregion_t *source);
  31 /*
  32  * Convert the text 'source' refers to into a DNS rdata type.
  33  *
  34  * Requires:
  35  *      'typep' is a valid pointer.
  36  *
  37  *      'source' is a valid text region.
  38  *
  39  * Returns:
  40  *      ISC_R_SUCCESS                   on success
  41  *      DNS_R_UNKNOWN                   type is unknown
  42  */
  43
  44 isc_result_t
  45 dns_rdatatype_totext(dns_rdatatype_t type, isc_buffer_t *target);
  46 /*
  47  * Put a textual representation of type 'type' into 'target'.
  48  *
  49  * Requires:
  50  *      'type' is a valid type.
  51  *
  52  *      'target' is a valid text buffer.
  53  *
  54  * Ensures:
  55  *      If the result is success:
  56  *              The used space in 'target' is updated.
  57  *
  58  * Returns:
  59  *      ISC_R_SUCCESS                   on success
  60  *      ISC_R_NOSPACE                   target buffer is too small
  61  */
  62
  63 void
  64 dns_rdatatype_format(dns_rdatatype_t rdtype,
  65                      char *array, unsigned int size);
  66 /*
  67  * Format a human-readable representation of the type 'rdtype'
  68  * into the character array 'array', which is of size 'size'.
  69  * The resulting string is guaranteed to be null-terminated.
  70  */
  71
  72 #define DNS_RDATATYPE_FORMATSIZE sizeof("TYPE65535")
  73 /*
  74  * Minimum size of array to pass to dns_rdatatype_format().
  75  * May need to be adjusted if a new RR type with a very long
  76  * name is defined.
  77  */
  78
  79 ISC_LANG_ENDDECLS
  80
  81 #endif /* DNS_RDATATYPE_H */