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 #include "librpc/gen_ndr/server_id.h"
  39 #include "lib/util/data_blob.h"
  40 #include "system/network.h"
  41
  42 #define MSG_BROADCAST_PID_STR   "0:0"
  43
  44 struct messaging_context;
  45 struct messaging_rec;
  46
  47 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx,
  48                                          struct tevent_context *ev);
  49
  50 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
  51 struct tevent_context *messaging_tevent_context(
  52         struct messaging_context *msg_ctx);
  53 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx);
  54
  55 /*
  56  * re-init after a fork
  57  */
  58 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
  59
  60 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
  61                             void *private_data,
  62                             uint32_t msg_type,
  63                             void (*fn)(struct messaging_context *msg,
  64                                        void *private_data,
  65                                        uint32_t msg_type,
  66                                        struct server_id server_id,
  67                                        DATA_BLOB *data));
  68 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
  69                           void *private_data);
  70
  71 /**
  72  * CAVEAT:
  73  *
  74  * While the messaging_send*() functions are synchronuous by API,
  75  * they trigger a tevent-based loop upon sending bigger messages.
  76  *
  77  * Hence callers should not use these in purely synchonous code,
  78  * but run a tevent_loop instead.
  79  */
  80 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
  81                         struct server_id server,
  82                         uint32_t msg_type, const DATA_BLOB *data);
  83
  84 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
  85                             struct server_id server, uint32_t msg_type,
  86                             const uint8_t *buf, size_t len);
  87 int messaging_send_iov_from(struct messaging_context *msg_ctx,
  88                             struct server_id src, struct server_id dst,
  89                             uint32_t msg_type,
  90                             const struct iovec *iov, int iovlen,
  91                             const int *fds, size_t num_fds);
  92 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
  93                             struct server_id server, uint32_t msg_type,
  94                             const struct iovec *iov, int iovlen,
  95                             const int *fds, size_t num_fds);
  96 void messaging_send_all(struct messaging_context *msg_ctx,
  97                         int msg_type, const void *buf, size_t len);
  98
  99 struct tevent_req *messaging_filtered_read_send(
 100         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 101         struct messaging_context *msg_ctx,
 102         bool (*filter)(struct messaging_rec *rec, void *private_data),
 103         void *private_data);
 104 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 105                                  struct messaging_rec **presult);
 106
 107 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
 108                                        struct tevent_context *ev,
 109                                        struct messaging_context *msg,
 110                                        uint32_t msg_type);
 111 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 112                         struct messaging_rec **presult);
 113
 114 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid);
 115
 116 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
 117
 118 struct messaging_rec *messaging_rec_create(
 119         TALLOC_CTX *mem_ctx, struct server_id src, struct server_id dst,
 120         uint32_t msg_type, const struct iovec *iov, int iovlen,
 121         const int *fds, size_t num_fds);
 122
 123 #include "librpc/gen_ndr/ndr_messaging.h"
 124
 125 #endif