/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef DNS_ORDER_H

[12] Fix | Delete

#define DNS_ORDER_H 1

[13] Fix | Delete

[14] Fix | Delete

/*! \file dns/order.h */

[15] Fix | Delete

[16] Fix | Delete

#include <isc/lang.h>

[17] Fix | Delete

#include <isc/types.h>

[18] Fix | Delete

[19] Fix | Delete

#include <dns/types.h>

[20] Fix | Delete

[21] Fix | Delete

ISC_LANG_BEGINDECLS

[22] Fix | Delete

[23] Fix | Delete

isc_result_t

[24] Fix | Delete

dns_order_create(isc_mem_t *mctx, dns_order_t **orderp);

[25] Fix | Delete

/*%<

[26] Fix | Delete

* Create a order object.

[27] Fix | Delete

*

[28] Fix | Delete

* Requires:

[29] Fix | Delete

* \li 'orderp' to be non NULL and '*orderp == NULL'.

[30] Fix | Delete

*\li 'mctx' to be valid.

[31] Fix | Delete

*

[32] Fix | Delete

* Returns:

[33] Fix | Delete

*\li ISC_R_SUCCESS

[34] Fix | Delete

*\li ISC_R_NOMEMORY

[35] Fix | Delete

*/

[36] Fix | Delete

[37] Fix | Delete

isc_result_t

[38] Fix | Delete

dns_order_add(dns_order_t *order, dns_name_t *name,

[39] Fix | Delete

dns_rdatatype_t rdtype, dns_rdataclass_t rdclass,

[40] Fix | Delete

unsigned int mode);

[41] Fix | Delete

/*%<

[42] Fix | Delete

* Add a entry to the end of the order list.

[43] Fix | Delete

*

[44] Fix | Delete

* Requires:

[45] Fix | Delete

* \li 'order' to be valid.

[46] Fix | Delete

*\li 'name' to be valid.

[47] Fix | Delete

*\li 'mode' to be one of #DNS_RDATASETATTR_RANDOMIZE,

[48] Fix | Delete

* #DNS_RDATASETATTR_FIXEDORDER or zero (#DNS_RDATASETATTR_CYCLIC).

[49] Fix | Delete

*

[50] Fix | Delete

* Returns:

[51] Fix | Delete

*\li #ISC_R_SUCCESS

[52] Fix | Delete

*\li #ISC_R_NOMEMORY

[53] Fix | Delete

*/

[54] Fix | Delete

[55] Fix | Delete

unsigned int

[56] Fix | Delete

dns_order_find(dns_order_t *order, dns_name_t *name,

[57] Fix | Delete

dns_rdatatype_t rdtype, dns_rdataclass_t rdclass);

[58] Fix | Delete

/*%<

[59] Fix | Delete

* Find the first matching entry on the list.

[60] Fix | Delete

*

[61] Fix | Delete

* Requires:

[62] Fix | Delete

*\li 'order' to be valid.

[63] Fix | Delete

*\li 'name' to be valid.

[64] Fix | Delete

*

[65] Fix | Delete

* Returns the mode set by dns_order_add() or zero.

[66] Fix | Delete

*/

[67] Fix | Delete

[68] Fix | Delete

void

[69] Fix | Delete

dns_order_attach(dns_order_t *source, dns_order_t **target);

[70] Fix | Delete

/*%<

[71] Fix | Delete

* Attach to the 'source' object.

[72] Fix | Delete

*

[73] Fix | Delete

* Requires:

[74] Fix | Delete

* \li 'source' to be valid.

[75] Fix | Delete

*\li 'target' to be non NULL and '*target == NULL'.

[76] Fix | Delete

*/

[77] Fix | Delete

[78] Fix | Delete

void

[79] Fix | Delete

dns_order_detach(dns_order_t **orderp);

[80] Fix | Delete

/*%<

[81] Fix | Delete

* Detach from the object. Clean up if last this was the last

[82] Fix | Delete

* reference.

[83] Fix | Delete

*

[84] Fix | Delete

* Requires:

[85] Fix | Delete

*\li '*orderp' to be valid.

[86] Fix | Delete

*/

[87] Fix | Delete

[88] Fix | Delete

ISC_LANG_ENDDECLS

[89] Fix | Delete

[90] Fix | Delete

#endif /* DNS_ORDER_H */

[91] Fix | Delete

[92] Fix | Delete