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