/contrib/bind9/lib/dns/include/dns/rdataclass.h
https://bitbucket.org/freebsd/freebsd-head/ · C Header · 81 lines · 15 code · 12 blank · 54 comment · 0 complexity · cd6828c58f42d9480f13b56f51cbb172 MD5 · raw file
- /*
- * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
- * Copyright (C) 1998-2001 Internet Software Consortium.
- *
- * Permission to use, copy, modify, and/or distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
- */
- /* $Id: rdataclass.h,v 1.24 2007/06/19 23:47:17 tbox Exp $ */
- #ifndef DNS_RDATACLASS_H
- #define DNS_RDATACLASS_H 1
- /*! \file dns/rdataclass.h */
- #include <isc/lang.h>
- #include <dns/types.h>
- ISC_LANG_BEGINDECLS
- isc_result_t
- dns_rdataclass_fromtext(dns_rdataclass_t *classp, isc_textregion_t *source);
- /*%<
- * Convert the text 'source' refers to into a DNS class.
- *
- * Requires:
- *\li 'classp' is a valid pointer.
- *
- *\li 'source' is a valid text region.
- *
- * Returns:
- *\li #ISC_R_SUCCESS on success
- *\li #DNS_R_UNKNOWN class is unknown
- */
- isc_result_t
- dns_rdataclass_totext(dns_rdataclass_t rdclass, isc_buffer_t *target);
- /*%<
- * Put a textual representation of class 'rdclass' into 'target'.
- *
- * Requires:
- *\li 'rdclass' is a valid class.
- *
- *\li 'target' is a valid text buffer.
- *
- * Ensures,
- * if the result is success:
- *\li The used space in 'target' is updated.
- *
- * Returns:
- *\li #ISC_R_SUCCESS on success
- *\li #ISC_R_NOSPACE target buffer is too small
- */
- void
- dns_rdataclass_format(dns_rdataclass_t rdclass,
- char *array, unsigned int size);
- /*%<
- * Format a human-readable representation of the class 'rdclass'
- * into the character array 'array', which is of size 'size'.
- * The resulting string is guaranteed to be null-terminated.
- */
- #define DNS_RDATACLASS_FORMATSIZE sizeof("CLASS65535")
- /*%<
- * Minimum size of array to pass to dns_rdataclass_format().
- */
- ISC_LANG_ENDDECLS
- #endif /* DNS_RDATACLASS_H */