]>
Commit | Line | Data |
---|---|---|
a47d6336 | 1 | /* $Id: dhcpctl.h,v 1.18 2009/11/24 02:06:56 sar Exp $ |
f50487df TL |
2 | |
3 | Subroutines providing general support for objects. */ | |
4 | ||
5 | /* | |
9121bf67 | 6 | * Copyright (c) 2004-2020 by Internet Systems Consortium, Inc. ("ISC") |
98311e4b | 7 | * Copyright (c) 1999-2003 by Internet Software Consortium |
f50487df | 8 | * |
98311e4b DH |
9 | * Permission to use, copy, modify, and distribute this software for any |
10 | * purpose with or without fee is hereby granted, provided that the above | |
11 | * copyright notice and this permission notice appear in all copies. | |
f50487df | 12 | * |
98311e4b DH |
13 | * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES |
14 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
15 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR | |
16 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
17 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
18 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT | |
19 | * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
f50487df | 20 | * |
98311e4b | 21 | * Internet Systems Consortium, Inc. |
429a56d7 TM |
22 | * PO Box 360 |
23 | * Newmarket, NH 03857 USA | |
98311e4b | 24 | * <info@isc.org> |
2c85ac9b | 25 | * https://www.isc.org/ |
49733f31 | 26 | * |
f50487df TL |
27 | */ |
28 | ||
7528da64 TL |
29 | #ifndef _DHCPCTL_H_ |
30 | #define _DHCPCTL_H_ | |
31 | ||
f50487df TL |
32 | #include <omapip/omapip.h> |
33 | ||
34 | typedef isc_result_t dhcpctl_status; | |
35 | typedef omapi_object_t *dhcpctl_handle; | |
36 | typedef omapi_data_string_t *dhcpctl_data_string; | |
37 | ||
49146f3c DN |
38 | #define dhcpctl_null_handle ((dhcpctl_handle) 0) |
39 | ||
40 | #define DHCPCTL_CREATE OMAPI_CREATE | |
41 | #define DHCPCTL_UPDATE OMAPI_UPDATE | |
42 | #define DHCPCTL_EXCL OMAPI_EXCL | |
f50487df TL |
43 | |
44 | typedef struct { | |
45 | OMAPI_OBJECT_PREAMBLE; | |
46 | omapi_object_t *object; | |
47 | void *data; | |
48 | void (*callback) (dhcpctl_handle, dhcpctl_status, void *); | |
49 | } dhcpctl_callback_object_t; | |
50 | ||
3d815309 TL |
51 | typedef struct { |
52 | OMAPI_OBJECT_PREAMBLE; | |
53 | omapi_typed_data_t *rtype; | |
54 | isc_result_t waitstatus; | |
55 | omapi_typed_data_t *message; | |
f5423ffa | 56 | omapi_handle_t remote_handle; |
3d815309 TL |
57 | } dhcpctl_remote_object_t; |
58 | ||
e47dc45a TL |
59 | extern omapi_object_type_t *dhcpctl_callback_type; |
60 | extern omapi_object_type_t *dhcpctl_remote_type; | |
f50487df TL |
61 | |
62 | dhcpctl_status dhcpctl_initialize (void); | |
63 | dhcpctl_status dhcpctl_connect (dhcpctl_handle *, | |
b1b7b521 | 64 | const char *, int, dhcpctl_handle); |
f50487df | 65 | dhcpctl_status dhcpctl_wait_for_completion (dhcpctl_handle, dhcpctl_status *); |
7f152466 TM |
66 | |
67 | dhcpctl_status dhcpctl_timed_wait_for_completion (dhcpctl_handle h, | |
68 | dhcpctl_status *s, | |
69 | struct timeval *t); | |
70 | ||
f50487df | 71 | dhcpctl_status dhcpctl_get_value (dhcpctl_data_string *, |
b1b7b521 TL |
72 | dhcpctl_handle, const char *); |
73 | dhcpctl_status dhcpctl_get_boolean (int *, dhcpctl_handle, const char *); | |
74 | dhcpctl_status dhcpctl_set_value (dhcpctl_handle, | |
75 | dhcpctl_data_string, const char *); | |
7528da64 TL |
76 | dhcpctl_status dhcpctl_set_string_value (dhcpctl_handle, const char *, |
77 | const char *); | |
31bbee78 TL |
78 | dhcpctl_status dhcpctl_set_data_value (dhcpctl_handle, |
79 | const char *, unsigned, const char *); | |
d758ad8c | 80 | dhcpctl_status dhcpctl_set_null_value (dhcpctl_handle, const char *); |
b1b7b521 TL |
81 | dhcpctl_status dhcpctl_set_boolean_value (dhcpctl_handle, int, const char *); |
82 | dhcpctl_status dhcpctl_set_int_value (dhcpctl_handle, int, const char *); | |
f50487df TL |
83 | dhcpctl_status dhcpctl_object_update (dhcpctl_handle, dhcpctl_handle); |
84 | dhcpctl_status dhcpctl_object_refresh (dhcpctl_handle, dhcpctl_handle); | |
83b89e97 | 85 | dhcpctl_status dhcpctl_object_remove (dhcpctl_handle, dhcpctl_handle); |
f50487df | 86 | |
3d815309 TL |
87 | dhcpctl_status dhcpctl_set_callback (dhcpctl_handle, void *, |
88 | void (*) (dhcpctl_handle, | |
89 | dhcpctl_status, void *)); | |
f50487df TL |
90 | isc_result_t dhcpctl_callback_set_value (omapi_object_t *, omapi_object_t *, |
91 | omapi_data_string_t *, | |
92 | omapi_typed_data_t *); | |
93 | isc_result_t dhcpctl_callback_get_value (omapi_object_t *, omapi_object_t *, | |
94 | omapi_data_string_t *, | |
f6b8f48d | 95 | omapi_value_t **); |
4bd8800e | 96 | isc_result_t dhcpctl_callback_destroy (omapi_object_t *, const char *, int); |
f50487df | 97 | isc_result_t dhcpctl_callback_signal_handler (omapi_object_t *, |
b1b7b521 | 98 | const char *, va_list); |
f50487df TL |
99 | isc_result_t dhcpctl_callback_stuff_values (omapi_object_t *, |
100 | omapi_object_t *, | |
101 | omapi_object_t *); | |
3d815309 | 102 | |
49146f3c DN |
103 | dhcpctl_status dhcpctl_new_authenticator (dhcpctl_handle *, |
104 | const char *, const char *, | |
6ad8c39d | 105 | const unsigned char *, unsigned); |
49146f3c | 106 | |
3d815309 | 107 | dhcpctl_status dhcpctl_open_object (dhcpctl_handle, dhcpctl_handle, int); |
b1b7b521 TL |
108 | dhcpctl_status dhcpctl_new_object (dhcpctl_handle *, |
109 | dhcpctl_handle, const char *); | |
3d815309 TL |
110 | isc_result_t dhcpctl_remote_set_value (omapi_object_t *, omapi_object_t *, |
111 | omapi_data_string_t *, | |
112 | omapi_typed_data_t *); | |
113 | isc_result_t dhcpctl_remote_get_value (omapi_object_t *, omapi_object_t *, | |
114 | omapi_data_string_t *, | |
f6b8f48d | 115 | omapi_value_t **); |
4bd8800e | 116 | isc_result_t dhcpctl_remote_destroy (omapi_object_t *, const char *, int); |
3d815309 | 117 | isc_result_t dhcpctl_remote_signal_handler (omapi_object_t *, |
b1b7b521 | 118 | const char *, va_list); |
3d815309 TL |
119 | isc_result_t dhcpctl_remote_stuff_values (omapi_object_t *, |
120 | omapi_object_t *, | |
121 | omapi_object_t *); | |
043eb4ea | 122 | isc_result_t dhcpctl_data_string_dereference (dhcpctl_data_string *, |
4bd8800e | 123 | const char *, int); |
7f152466 TM |
124 | |
125 | dhcpctl_status dhcpctl_disconnect (dhcpctl_handle *, int); | |
126 | ||
89619cf9 | 127 | #endif /* _DHCPCTL_H_ */ |