include/cfg.h

   1 /*
   2  * Copyright (c) 2005 MontaVista Software, Inc.
   3  *
   4  * All rights reserved.
   5  *
   6  * Author: Steven Dake (sdake@mvista.com)
   7  *
   8  * This software licensed under BSD license, the text of which follows:
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * - Redistributions of source code must retain the above copyright notice,
  14  *   this list of conditions and the following disclaimer.
  15  * - Redistributions in binary form must reproduce the above copyright notice,
  16  *   this list of conditions and the following disclaimer in the documentation
  17  *   and/or other materials provided with the distribution.
  18  * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19  *   contributors may be used to endorse or promote products derived from this
  20  *   software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34 #ifndef AIS_OPENAISCFG_H_DEFINED
  35 #define AIS_OPENAISCFG_H_DEFINED
  36
  37 #include <netinet/in.h>
  38 #include "saAis.h"
  39
  40 typedef SaUint64T OpenaisCfgHandleT;
  41
  42 typedef enum {
  43         OPENAIS_CFG_ADMINISTRATIVETARGET_SERVICEUNIT = 0,
  44         OPENAIS_CFG_ADMINISTRATIVETARGET_SERVICEGROUP = 1,
  45         OPENAIS_CFG_ADMINISTRATIVETARGET_COMPONENTSERVICEINSTANCE = 2,
  46         OPENAIS_CFG_ADMINISTRATIVETARGET_NODE = 3
  47 } OpenaisCfgAdministrativeTargetT;
  48
  49 typedef enum {
  50         OPENAIS_CFG_ADMINISTRATIVESTATE_UNLOCKED = 0,
  51         OPENAIS_CFG_ADMINISTRATIVESTATE_LOCKED = 1,
  52         OPENAIS_CFG_ADMINISTRATIVESTATE_STOPPING = 2
  53 } OpenaisCfgAdministrativeStateT;
  54
  55 typedef enum {
  56         OPENAIS_CFG_OPERATIONALSTATE_ENABLED = 1,
  57         OPENAIS_CFG_OPERATIONALSTATE_DISABLED = 2
  58 } OpenaisCfgOperationalStateT;
  59
  60 typedef enum {
  61         OPENAIS_CFG_READINESSSTATE_OUTOFSERVICE = 1,
  62         OPENAIS_CFG_READINESSSTATE_INSERVICE = 2,
  63         OPENAIS_CFG_READINESSSTATE_STOPPING = 3
  64 } OpenaisCfgReadinessStateT;
  65
  66 typedef enum {
  67         OPENAIS_CFG_PRESENCESTATE_UNINSTANTIATED = 1,
  68         OPENAIS_CFG_PRESENCESTATE_INSTANTIATING = 2,
  69         OPENAIS_CFG_PRESENCESTATE_INSTANTIATED = 3,
  70         OPENAIS_CFG_PRESENCESTATE_TERMINATING = 4,
  71         OPENAIS_CFG_PRESENCESTATE_RESTARTING = 5,
  72         OPENAIS_CFG_PRESENCESTATE_INSTANTIATION_FAILED = 6,
  73         OPENAIS_CFG_PRESENCESTATE_TERMINATION_FAILED = 7
  74 } OpenaisCfgPresenceStateT;
  75
  76 typedef enum {
  77         OPENAIS_CFG_STATETYPE_OPERATIONAL = 0,
  78         OPENAIS_CFG_STATETYPE_ADMINISTRATIVE = 1,
  79         OPENAIS_CFG_STATETYPE_READINESS = 2,
  80         OPENAIS_CFG_STATETYPE_HA = 3,
  81         OPENAIS_CFG_STATETYPE_PRESENCE = 4
  82 } OpenaisCfgStateTypeT;
  83
  84 typedef struct {
  85         SaNameT name;
  86         OpenaisCfgStateTypeT stateType;
  87         OpenaisCfgAdministrativeStateT administrativeState;
  88 } OpenaisCfgStateNotificationT;
  89
  90 typedef struct {
  91         SaUint32T numberOfItems;
  92         OpenaisCfgStateNotificationT *notification;
  93 } OpenaisCfgStateNotificationBufferT;
  94
  95 typedef void (*OpenaisCfgStateTrackCallbackT) (
  96         OpenaisCfgStateNotificationBufferT *notificationBuffer,
  97         SaAisErrorT error);
  98
  99 typedef struct {
 100         OpenaisCfgStateTrackCallbackT
 101                 openaisCfgStateTrackCallback;
 102 } OpenaisCfgCallbacksT;
 103
 104 /*
 105  * Interfaces
 106  */
 107 #ifdef __cplusplus
 108 extern "C" {
 109 #endif
 110
 111 SaAisErrorT
 112 openaisCfgInitialize (
 113         OpenaisCfgHandleT *cfgHandle,
 114         const OpenaisCfgCallbacksT *cfgCallbacks,
 115         SaVersionT *version);
 116
 117 SaAisErrorT
 118 openaisCfgSelectionObjectGet (
 119         OpenaisCfgHandleT cfgHandle,
 120         SaSelectionObjectT *selectionObject);
 121
 122 SaAisErrorT
 123 openaisCfgDispatch (
 124         OpenaisCfgHandleT cfgHandle,
 125         SaDispatchFlagsT dispatchFlags);
 126
 127 SaAisErrorT
 128 openaisCfgFinalize (
 129         OpenaisCfgHandleT cfgHandle);
 130
 131 SaAisErrorT
 132 openaisCfgAdministrativeStateGet (
 133         OpenaisCfgHandleT cfgHandle,
 134         OpenaisCfgAdministrativeTargetT administrativeTarget,
 135         OpenaisCfgAdministrativeStateT *administrativeState);
 136
 137 SaAisErrorT
 138 openaisCfgAdministrativeStateSet (
 139         OpenaisCfgHandleT cfgHandle,
 140         OpenaisCfgAdministrativeTargetT administrativeTarget,
 141         OpenaisCfgAdministrativeStateT administrativeState);
 142
 143 SaAisErrorT
 144 openaisCfgStateTrackStart (
 145         OpenaisCfgHandleT cfgHandle,
 146         SaUint8T trackFlags,
 147         const OpenaisCfgStateNotificationT *notificationBuffer);
 148
 149 SaAisErrorT
 150 openaisCfgStateTrackStop (
 151         OpenaisCfgHandleT cfgHandle);
 152
 153 #ifdef __cplusplus
 154 }
 155 #endif
 156
 157 #endif /* AIS_OPENAISCFG_H_DEFINED */