corosync  3.1.6
sam.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009-2011 Red Hat, Inc.
3  *
4  * All rights reserved.
5  *
6  * Author: Jan Friesse (jfriesse@redhat.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 Red Hat, 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 COROSYNC_SAM_H_DEFINED
35 #define COROSYNC_SAM_H_DEFINED
36 
37 #include <corosync/corotypes.h>
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
46 typedef enum {
55 
59 typedef int (*sam_hc_callback_t)(void);
60 
80  int time_interval,
82 
95 
105 cs_error_t sam_start (void);
106 
117 cs_error_t sam_stop (void);
118 
130 
151  unsigned int *instance_id);
152 
162 cs_error_t sam_hc_send (void);
163 
183 
195 cs_error_t sam_data_getsize (size_t *size);
196 
208  void *data,
209  size_t size);
210 
228  const void *data,
229  size_t size);
230 
245 
246 #ifdef __cplusplus
247 }
248 #endif
249 
250 #endif /* COROSYNC_SAM_H_DEFINED */
cs_error_t
The cs_error_t enum.
Definition: corotypes.h:98
int time_interval
Definition: sam.c:112
unsigned int instance_id
Definition: sam.c:115
sam_recovery_policy_t recovery_policy
Definition: sam.c:113
int warn_signal
Definition: sam.c:119
cs_error_t sam_warn_signal_set(int warn_signal)
Set warning signal to be sent.
Definition: sam.c:741
cs_error_t sam_finalize(void)
Close the SAM handle.
Definition: sam.c:696
cs_error_t sam_hc_callback_register(sam_hc_callback_t cb)
Register healtcheck callback.
Definition: sam.c:1406
cs_error_t sam_data_store(const void *data, size_t size)
Store user data.
Definition: sam.c:498
sam_recovery_policy_t
sam_recovery_policy_t enum
Definition: sam.h:46
@ SAM_RECOVERY_POLICY_CMAP
Definition: sam.h:52
@ SAM_RECOVERY_POLICY_QUORUM_RESTART
Definition: sam.h:51
@ SAM_RECOVERY_POLICY_QUORUM
Definition: sam.h:49
@ SAM_RECOVERY_POLICY_QUORUM_QUIT
Definition: sam.h:50
@ SAM_RECOVERY_POLICY_QUIT
Definition: sam.h:47
@ SAM_RECOVERY_POLICY_CONFDB
Definition: sam.h:53
@ SAM_RECOVERY_POLICY_RESTART
Definition: sam.h:48
cs_error_t sam_mark_failed(void)
Marks child as failed.
Definition: sam.c:720
cs_error_t sam_data_restore(void *data, size_t size)
Return stored data.
Definition: sam.c:453
cs_error_t sam_register(unsigned int *instance_id)
Register application.
Definition: sam.c:1203
cs_error_t sam_data_getsize(size_t *size)
Return size of stored data.
Definition: sam.c:431
cs_error_t sam_stop(void)
Stop healthchecking.
Definition: sam.c:635
cs_error_t sam_initialize(int time_interval, sam_recovery_policy_t recovery_policy)
Create a new SAM connection.
Definition: sam.c:275
cs_error_t sam_hc_send(void)
Send healthcheck confirmation.
Definition: sam.c:680
int(* sam_hc_callback_t)(void)
Callback definition for event driven checking.
Definition: sam.h:59
cs_error_t sam_start(void)
Start healthchecking.
Definition: sam.c:587