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