/*

[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_TTL_H

[12] Fix | Delete

#define DNS_TTL_H 1

[13] Fix | Delete

[14] Fix | Delete

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

[15] Fix | Delete

[16] Fix | Delete

/***

[17] Fix | Delete

*** Imports

[18] Fix | Delete

***/

[19] Fix | Delete

[20] Fix | Delete

#include <stdbool.h>

[21] Fix | Delete

[22] Fix | Delete

#include <isc/lang.h>

[23] Fix | Delete

#include <isc/types.h>

[24] Fix | Delete

[25] Fix | Delete

ISC_LANG_BEGINDECLS

[26] Fix | Delete

[27] Fix | Delete

/***

[28] Fix | Delete

*** Functions

[29] Fix | Delete

***/

[30] Fix | Delete

[31] Fix | Delete

isc_result_t

[32] Fix | Delete

dns_ttl_totext(uint32_t src, bool verbose,

[33] Fix | Delete

isc_buffer_t *target);

[34] Fix | Delete

isc_result_t

[35] Fix | Delete

dns_ttl_totext2(uint32_t src, bool verbose,

[36] Fix | Delete

bool upcase, isc_buffer_t *target);

[37] Fix | Delete

/*%<

[38] Fix | Delete

* Output a TTL or other time interval in a human-readable form.

[39] Fix | Delete

* The time interval is given as a count of seconds in 'src'.

[40] Fix | Delete

* The text representation is appended to 'target'.

[41] Fix | Delete

*

[42] Fix | Delete

* If 'verbose' is false, use the terse BIND 8 style, like "1w2d3h4m5s".

[43] Fix | Delete

*

[44] Fix | Delete

* If 'verbose' is true, use a verbose style like the SOA comments

[45] Fix | Delete

* in "dig", like "1 week 2 days 3 hours 4 minutes 5 seconds".

[46] Fix | Delete

*

[47] Fix | Delete

* If 'upcase' is true, we conform to the BIND 8 style in which

[48] Fix | Delete

* the unit letter is capitalized if there is only a single unit

[49] Fix | Delete

* letter to print (for example, "1m30s", but "2M")

[50] Fix | Delete

*

[51] Fix | Delete

* If 'upcase' is false, unit letters are always in lower case.

[52] Fix | Delete

*

[53] Fix | Delete

* Returns:

[54] Fix | Delete

* \li ISC_R_SUCCESS

[55] Fix | Delete

* \li ISC_R_NOSPACE

[56] Fix | Delete

*/

[57] Fix | Delete

[58] Fix | Delete

isc_result_t

[59] Fix | Delete

dns_counter_fromtext(isc_textregion_t *source, uint32_t *ttl);

[60] Fix | Delete

/*%<

[61] Fix | Delete

* Converts a counter from either a plain number or a BIND 8 style value.

[62] Fix | Delete

*

[63] Fix | Delete

* Returns:

[64] Fix | Delete

*\li ISC_R_SUCCESS

[65] Fix | Delete

*\li DNS_R_SYNTAX

[66] Fix | Delete

*/

[67] Fix | Delete

[68] Fix | Delete

isc_result_t

[69] Fix | Delete

dns_ttl_fromtext(isc_textregion_t *source, uint32_t *ttl);

[70] Fix | Delete

/*%<

[71] Fix | Delete

* Converts a ttl from either a plain number or a BIND 8 style value.

[72] Fix | Delete

*

[73] Fix | Delete

* Returns:

[74] Fix | Delete

*\li ISC_R_SUCCESS

[75] Fix | Delete

*\li DNS_R_BADTTL

[76] Fix | Delete

*/

[77] Fix | Delete

[78] Fix | Delete

ISC_LANG_ENDDECLS

[79] Fix | Delete

[80] Fix | Delete

#endif /* DNS_TTL_H */

[81] Fix | Delete

[82] Fix | Delete