lib: Move "message_send_all" to serverid.c
[nivanova/samba-autobuild/.git] / source3 / include / messages.h
1 /* 
2    Unix SMB/CIFS implementation.
3    messages.c header
4    Copyright (C) Andrew Tridgell 2000
5    Copyright (C) 2001, 2002 by Martin Pool
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _MESSAGES_H_
22 #define _MESSAGES_H_
23
24 /* change the message version with any incompatible changes in the protocol */
25 #define MESSAGE_VERSION 2
26
27 /*
28  * Special flags passed to message_send. Allocated from the top, lets see when
29  * it collides with the message types in the lower 16 bits :-)
30  */
31
32 /*
33  * Under high load, this message can be dropped. Use for notify-style
34  * messages that are not critical for correct operation.
35  */
36 #define MSG_FLAG_LOWPRIORITY            0x80000000
37
38
39 /*
40  * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
41  * pid clashes and to be able to register for special messages like "all
42  * smbds".
43  *
44  * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
45  * Samba, other subsystems might use something else.
46  */
47
48 #define MSG_SRVID_SAMBA 0x0000000100000000LL
49
50 #include "librpc/gen_ndr/server_id.h"
51 #include "lib/util/data_blob.h"
52 #include "system/network.h"
53
54 #define MSG_BROADCAST_PID_STR   "0:0"
55
56 struct messaging_context;
57 struct messaging_rec;
58
59 struct messaging_backend {
60         int (*send_fn)(struct server_id src,
61                        struct server_id pid, int msg_type,
62                        const struct iovec *iov, int iovlen,
63                        const int *fds, size_t num_fds,
64                        struct messaging_backend *backend);
65         void *private_data;
66 };
67
68 int messaging_ctdbd_init(struct messaging_context *msg_ctx,
69                          TALLOC_CTX *mem_ctx,
70                          struct messaging_backend **presult);
71 int messaging_ctdbd_reinit(struct messaging_context *msg_ctx,
72                            TALLOC_CTX *mem_ctx,
73                            struct messaging_backend *backend);
74 struct ctdbd_connection *messaging_ctdbd_connection(void);
75
76 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, 
77                                          struct tevent_context *ev);
78
79 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
80 struct tevent_context *messaging_tevent_context(
81         struct messaging_context *msg_ctx);
82 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx);
83
84 /*
85  * re-init after a fork
86  */
87 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
88
89 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
90                             void *private_data,
91                             uint32_t msg_type,
92                             void (*fn)(struct messaging_context *msg,
93                                        void *private_data, 
94                                        uint32_t msg_type, 
95                                        struct server_id server_id,
96                                        DATA_BLOB *data));
97 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
98                           void *private_data);
99
100 /**
101  * CAVEAT:
102  *
103  * While the messaging_send*() functions are synchronuous by API,
104  * they trigger a tevent-based loop upon sending bigger messages.
105  *
106  * Hence callers should not use these in purely synchonous code,
107  * but run a tevent_loop instead.
108  */
109 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
110                         struct server_id server, 
111                         uint32_t msg_type, const DATA_BLOB *data);
112
113 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
114                             struct server_id server, uint32_t msg_type,
115                             const uint8_t *buf, size_t len);
116 int messaging_send_iov_from(struct messaging_context *msg_ctx,
117                             struct server_id src, struct server_id dst,
118                             uint32_t msg_type,
119                             const struct iovec *iov, int iovlen,
120                             const int *fds, size_t num_fds);
121 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
122                             struct server_id server, uint32_t msg_type,
123                             const struct iovec *iov, int iovlen,
124                             const int *fds, size_t num_fds);
125
126 struct tevent_req *messaging_filtered_read_send(
127         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
128         struct messaging_context *msg_ctx,
129         bool (*filter)(struct messaging_rec *rec, void *private_data),
130         void *private_data);
131 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
132                                  struct messaging_rec **presult);
133
134 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
135                                        struct tevent_context *ev,
136                                        struct messaging_context *msg,
137                                        uint32_t msg_type);
138 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
139                         struct messaging_rec **presult);
140
141 struct tevent_req *messaging_handler_send(
142         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
143         struct messaging_context *msg_ctx, uint32_t msg_type,
144         bool (*handler)(struct messaging_context *msg_ctx,
145                         struct messaging_rec **rec, void *private_data),
146         void *private_data);
147 int messaging_handler_recv(struct tevent_req *req);
148
149 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid);
150
151 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
152
153 #include "librpc/gen_ndr/ndr_messaging.h"
154
155 #endif