dhcpctl/dhcpctl.h

   1 /* $Id: dhcpctl.h,v 1.18 2009/11/24 02:06:56 sar Exp $
   2
   3    Subroutines providing general support for objects. */
   4
   5 /*
   6  * Copyright (C) 2004-2022 Internet Systems Consortium, Inc. ("ISC")
   7  * Copyright (c) 1999-2003 by Internet Software Consortium
   8  *
   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.
  12  *
  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.
  20  *
  21  *   Internet Systems Consortium, Inc.
  22  *   PO Box 360
  23  *   Newmarket, NH 03857 USA
  24  *   <info@isc.org>
  25  *   https://www.isc.org/
  26  *
  27  */
  28
  29 #ifndef _DHCPCTL_H_
  30 #define _DHCPCTL_H_
  31
  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
  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
  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
  51 typedef struct {
  52         OMAPI_OBJECT_PREAMBLE;
  53         omapi_typed_data_t *rtype;
  54         isc_result_t waitstatus;
  55         omapi_typed_data_t *message;
  56         omapi_handle_t remote_handle;
  57 } dhcpctl_remote_object_t;
  58
  59 extern omapi_object_type_t *dhcpctl_callback_type;
  60 extern omapi_object_type_t *dhcpctl_remote_type;
  61
  62 dhcpctl_status dhcpctl_initialize (void);
  63 dhcpctl_status dhcpctl_connect (dhcpctl_handle *,
  64                                 const char *, int, dhcpctl_handle);
  65
  66 dhcpctl_status dhcpctl_timed_connect (dhcpctl_handle *, const char *,
  67                                       int, dhcpctl_handle, struct timeval *);
  68
  69 dhcpctl_status dhcpctl_wait_for_completion (dhcpctl_handle, dhcpctl_status *);
  70
  71 dhcpctl_status dhcpctl_timed_wait_for_completion (dhcpctl_handle h,
  72                                                   dhcpctl_status *s,
  73                                                   struct timeval *t);
  74
  75 dhcpctl_status dhcpctl_get_value (dhcpctl_data_string *,
  76                                   dhcpctl_handle, const char *);
  77 dhcpctl_status dhcpctl_get_boolean (int *, dhcpctl_handle, const char *);
  78 dhcpctl_status dhcpctl_set_value (dhcpctl_handle,
  79                                   dhcpctl_data_string, const char *);
  80 dhcpctl_status dhcpctl_set_string_value (dhcpctl_handle, const char *,
  81                                          const char *);
  82 dhcpctl_status dhcpctl_set_data_value (dhcpctl_handle,
  83                                        const char *, unsigned, const char *);
  84 dhcpctl_status dhcpctl_set_null_value (dhcpctl_handle, const char *);
  85 dhcpctl_status dhcpctl_set_boolean_value (dhcpctl_handle, int, const char *);
  86 dhcpctl_status dhcpctl_set_int_value (dhcpctl_handle, int, const char *);
  87 dhcpctl_status dhcpctl_object_update (dhcpctl_handle, dhcpctl_handle);
  88 dhcpctl_status dhcpctl_object_refresh (dhcpctl_handle, dhcpctl_handle);
  89 dhcpctl_status dhcpctl_object_remove (dhcpctl_handle, dhcpctl_handle);
  90
  91 dhcpctl_status dhcpctl_set_callback (dhcpctl_handle, void *,
  92                                      void (*) (dhcpctl_handle,
  93                                                dhcpctl_status, void *));
  94 isc_result_t dhcpctl_callback_set_value  (omapi_object_t *, omapi_object_t *,
  95                                           omapi_data_string_t *,
  96                                           omapi_typed_data_t *);
  97 isc_result_t dhcpctl_callback_get_value (omapi_object_t *, omapi_object_t *,
  98                                          omapi_data_string_t *,
  99                                          omapi_value_t **);
 100 isc_result_t dhcpctl_callback_destroy (omapi_object_t *, const char *, int);
 101 isc_result_t dhcpctl_callback_signal_handler (omapi_object_t *,
 102                                               const char *, va_list);
 103 isc_result_t dhcpctl_callback_stuff_values (omapi_object_t *,
 104                                             omapi_object_t *,
 105                                             omapi_object_t *);
 106
 107 dhcpctl_status dhcpctl_new_authenticator (dhcpctl_handle *,
 108                                           const char *, const char *,
 109                                           const unsigned char *, unsigned);
 110
 111 dhcpctl_status dhcpctl_open_object (dhcpctl_handle, dhcpctl_handle, int);
 112 dhcpctl_status dhcpctl_new_object (dhcpctl_handle *,
 113                                    dhcpctl_handle, const char *);
 114 isc_result_t dhcpctl_remote_set_value  (omapi_object_t *, omapi_object_t *,
 115                                         omapi_data_string_t *,
 116                                         omapi_typed_data_t *);
 117 isc_result_t dhcpctl_remote_get_value (omapi_object_t *, omapi_object_t *,
 118                                        omapi_data_string_t *,
 119                                        omapi_value_t **);
 120 isc_result_t dhcpctl_remote_destroy (omapi_object_t *, const char *, int);
 121 isc_result_t dhcpctl_remote_signal_handler (omapi_object_t *,
 122                                             const char *, va_list);
 123 isc_result_t dhcpctl_remote_stuff_values (omapi_object_t *,
 124                                           omapi_object_t *,
 125                                           omapi_object_t *);
 126 isc_result_t dhcpctl_data_string_dereference (dhcpctl_data_string *,
 127                                               const char *, int);
 128
 129 dhcpctl_status dhcpctl_disconnect (dhcpctl_handle *, int);
 130
 131 #endif /* _DHCPCTL_H_ */