changes in cluster API
[public/netxms.git] / include / nxcc.h
1 #ifndef _nxcc_h_
2 #define _nxcc_h_
3
4 #ifdef _WIN32
5 #ifdef LIBNXCC_EXPORTS
6 #define LIBNXCC_EXPORTABLE __declspec(dllexport)
7 #else
8 #define LIBNXCC_EXPORTABLE __declspec(dllimport)
9 #endif
10 #else /* _WIN32 */
11 #define LIBNXCC_EXPORTABLE
12 #endif
13
14 #include <nms_common.h>
15 #include <nms_util.h>
16 #include <nms_threads.h>
17 #include <nxcpapi.h>
18 #include <nxconfig.h>
19
20 /**
21 * Cluster error codes
22 */
23 #define NXCC_RCC_SUCCESS 0
24 #define NXCC_RCC_INVALID_NODE 1
25 #define NXCC_RCC_TIMEOUT 2
26 #define NXCC_RCC_COMM_FAILURE 3
27 #define NXCC_RCC_NOT_MASTER 4
28 #define NXCC_RCC_INVALID_REQUEST 5
29
30 /**
31 * Cluster node states
32 */
33 enum ClusterNodeState
34 {
35 CLUSTER_NODE_DOWN = 0,
36 CLUSTER_NODE_CONNECTED = 1,
37 CLUSTER_NODE_SYNC = 2,
38 CLUSTER_NODE_UP = 3
39 };
40
41 /**
42 * Cluster message processing result
43 */
44 enum ClusterMessageProcessingResult
45 {
46 CLUSTER_MSG_IGNORED = 0,
47 CLUSTER_MSG_PROCESSED = 1,
48 CLUSTER_MSG_QUEUED = 2
49 };
50
51 /**
52 * Cluster node event handler
53 */
54 class LIBNXCC_EXPORTABLE ClusterEventHandler
55 {
56 public:
57 ClusterEventHandler();
58 virtual ~ClusterEventHandler();
59
60 virtual void onNodeJoin(UINT32 nodeId);
61 virtual void onNodeUp(UINT32 nodeId);
62 virtual void onNodeDisconnect(UINT32 nodeId);
63 virtual void onShutdown();
64 virtual void onSplitBrain();
65
66 virtual ClusterMessageProcessingResult onMessage(NXCPMessage *msg, UINT32 sourceNodeId);
67 };
68
69 /**
70 * API functions
71 */
72 bool LIBNXCC_EXPORTABLE ClusterInit(Config *config, const TCHAR *section, ClusterEventHandler *eventHandler);
73 bool LIBNXCC_EXPORTABLE ClusterJoin();
74 void LIBNXCC_EXPORTABLE ClusterSetRunning();
75 void LIBNXCC_EXPORTABLE ClusterShutdown();
76
77 UINT32 LIBNXCC_EXPORTABLE ClusterGetLocalNodeId();
78 UINT32 LIBNXCC_EXPORTABLE ClusterGetMasterNodeId();
79 bool LIBNXCC_EXPORTABLE ClusterIsMasterNode();
80 bool LIBNXCC_EXPORTABLE ClusterIsSyncNeeded();
81 bool LIBNXCC_EXPORTABLE ClusterAllNodesConnected();
82
83 void LIBNXCC_EXPORTABLE ClusterNotify(NXCPMessage *msg);
84 void LIBNXCC_EXPORTABLE ClusterNotify(INT16 code);
85 void LIBNXCC_EXPORTABLE ClusterDirectNotify(UINT32 nodeId, INT16 code);
86 void LIBNXCC_EXPORTABLE ClusterDirectNotify(UINT32 nodeId, NXCPMessage *msg);
87 int LIBNXCC_EXPORTABLE ClusterSendCommand(NXCPMessage *msg);
88 UINT32 LIBNXCC_EXPORTABLE ClusterSendDirectCommand(UINT32 nodeId, NXCPMessage *msg);
89 NXCPMessage LIBNXCC_EXPORTABLE *ClusterSendDirectCommandEx(UINT32 nodeId, NXCPMessage *msg);
90 void LIBNXCC_EXPORTABLE ClusterSendResponse(UINT32 nodeId, UINT32 requestId, UINT32 rcc);
91 void LIBNXCC_EXPORTABLE ClusterSendResponseEx(UINT32 nodeId, UINT32 requestId, NXCPMessage *msg);
92
93 #endif