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 #include "replace.h"
  25 #include <tevent.h>
  26 #include "libcli/util/ntstatus.h"
  27
  28 /* change the message version with any incompatible changes in the protocol */
  29 #define MESSAGE_VERSION 2
  30
  31 /*
  32  * Special flags passed to message_send. Allocated from the top, lets see when
  33  * it collides with the message types in the lower 16 bits :-)
  34  */
  35
  36 /*
  37  * Under high load, this message can be dropped. Use for notify-style
  38  * messages that are not critical for correct operation.
  39  */
  40 #define MSG_FLAG_LOWPRIORITY            0x80000000
  41
  42 #include "librpc/gen_ndr/server_id.h"
  43 #include "lib/util/data_blob.h"
  44 #include "system/network.h"
  45
  46 #define MSG_BROADCAST_PID_STR   "0:0"
  47
  48 struct messaging_context;
  49 struct messaging_rec;
  50
  51 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
  52                                          struct tevent_context *ev);
  53
  54 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
  55 struct tevent_context *messaging_tevent_context(
  56         struct messaging_context *msg_ctx);
  57 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx);
  58
  59 /*
  60  * re-init after a fork
  61  */
  62 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
  63
  64 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
  65                             void *private_data,
  66                             uint32_t msg_type,
  67                             void (*fn)(struct messaging_context *msg,
  68                                        void *private_data,
  69                                        uint32_t msg_type,
  70                                        struct server_id server_id,
  71                                        DATA_BLOB *data));
  72 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
  73                           void *private_data);
  74
  75 /**
  76  * CAVEAT:
  77  *
  78  * While the messaging_send*() functions are synchronous by API,
  79  * they trigger a tevent-based loop upon sending bigger messages.
  80  *
  81  * Hence callers should not use these in purely synchronous code,
  82  * but run a tevent_loop instead.
  83  */
  84 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
  85                         struct server_id server,
  86                         uint32_t msg_type, const DATA_BLOB *data);
  87
  88 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
  89                             struct server_id server, uint32_t msg_type,
  90                             const uint8_t *buf, size_t len);
  91 int messaging_send_iov_from(struct messaging_context *msg_ctx,
  92                             struct server_id src, struct server_id dst,
  93                             uint32_t msg_type,
  94                             const struct iovec *iov, int iovlen,
  95                             const int *fds, size_t num_fds);
  96 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
  97                             struct server_id server, uint32_t msg_type,
  98                             const struct iovec *iov, int iovlen,
  99                             const int *fds, size_t num_fds);
 100 void messaging_send_all(struct messaging_context *msg_ctx,
 101                         int msg_type, const void *buf, size_t len);
 102
 103 struct tevent_req *messaging_filtered_read_send(
 104         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 105         struct messaging_context *msg_ctx,
 106         bool (*filter)(struct messaging_rec *rec, void *private_data),
 107         void *private_data);
 108 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 109                                  struct messaging_rec **presult);
 110
 111 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
 112                                        struct tevent_context *ev,
 113                                        struct messaging_context *msg,
 114                                        uint32_t msg_type);
 115 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 116                         struct messaging_rec **presult);
 117
 118 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid);
 119
 120 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
 121
 122 struct messaging_rec *messaging_rec_create(
 123         TALLOC_CTX *mem_ctx, struct server_id src, struct server_id dst,
 124         uint32_t msg_type, const struct iovec *iov, int iovlen,
 125         const int *fds, size_t num_fds);
 126
 127 #include "librpc/gen_ndr/ndr_messaging.h"
 128
 129 #endif