1/*
2 * librdkafka - Apache Kafka C library
3 *
4 * Copyright (c) 2014-2018 Magnus Edenhill
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef _RDKAFKA_CONFVAL_H_
30#define _RDKAFKA_CONFVAL_H_
31/**
32 * @name Next generation configuration values
33 * @{
34 *
35 */
36
37/**
38 * @brief Configuration value type
39 */
40typedef enum rd_kafka_confval_type_t {
41 RD_KAFKA_CONFVAL_INT,
42 RD_KAFKA_CONFVAL_STR,
43 RD_KAFKA_CONFVAL_PTR,
44} rd_kafka_confval_type_t;
45
46/**
47 * @brief Configuration value (used by AdminOption).
48 * Comes with a type, backed by a union, and a flag to indicate
49 * if the value has been set or not.
50 */
51typedef struct rd_kafka_confval_s {
52 const char *name; /**< Property name */
53 rd_kafka_confval_type_t valuetype; /**< Value type, maps to union.*/
54 int is_set; /**< Value has been set. */
55 int is_enabled; /**< Confval is enabled. */
56 union {
57 struct {
58 int v; /**< Current value */
59 int vmin; /**< Minimum value (inclusive) */
60 int vmax; /**< Maximum value (inclusive) */
61 int vdef; /**< Default value */
62 } INT;
63 struct {
64 char *v; /**< Current value */
65 int allowempty; /**< Allow empty string as value */
66 size_t minlen; /**< Minimum string length excl \0 */
67 size_t maxlen; /**< Maximum string length excl \0 */
68 const char *vdef; /**< Default value */
69 } STR;
70 void *PTR; /**< Pointer */
71 } u;
72} rd_kafka_confval_t;
73
74
75
76void rd_kafka_confval_init_int (rd_kafka_confval_t *confval,
77 const char *name,
78 int vmin, int vmax, int vdef);
79void rd_kafka_confval_init_ptr (rd_kafka_confval_t *confval,
80 const char *name);
81void rd_kafka_confval_disable (rd_kafka_confval_t *confval, const char *name);
82
83rd_kafka_resp_err_t
84rd_kafka_confval_set_type (rd_kafka_confval_t *confval,
85 rd_kafka_confval_type_t valuetype,
86 const void *valuep,
87 char *errstr, size_t errstr_size);
88
89int rd_kafka_confval_get_int (const rd_kafka_confval_t *confval);
90const char *rd_kafka_confval_get_str (const rd_kafka_confval_t *confval);
91void *rd_kafka_confval_get_ptr (const rd_kafka_confval_t *confval);
92
93/**@}*/
94
95
96#endif /* _RDKAFKA_CONFVAL_H_ */
97