source/smbd/process_model.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    process model manager - structures
   5
   6    Copyright (C) Andrew Tridgell 1992-2005
   7    Copyright (C) James J Myers 2003 <myersjj@samba.org>
   8    Copyright (C) Stefan (metze) Metzmacher 2004-2005
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 */
  24
  25 #ifndef __PROCESS_MODEL_H__
  26 #define __PROCESS_MODEL_H__
  27
  28 #include "lib/socket/socket.h"
  29 #include "smbd/service_task.h"
  30
  31 /* modules can use the following to determine if the interface has changed
  32  * please increment the version number after each interface change
  33  * with a comment and maybe update struct process_model_critical_sizes.
  34  */
  35 /* version 1 - initial version - metze */
  36 #define PROCESS_MODEL_VERSION 1
  37
  38 /* the process model operations structure - contains function pointers to
  39    the model-specific implementations of each operation */
  40 struct model_ops {
  41         /* the name of the process_model */
  42         const char *name;
  43
  44         /* called at startup when the model is selected */
  45         void (*model_init)(struct event_context *);
  46
  47         /* function to accept new connection */
  48         void (*accept_connection)(struct event_context *, struct socket_context *,
  49                                   void (*)(struct event_context *, struct socket_context *,
  50                                            struct server_id , void *),
  51                                   void *);
  52
  53         /* function to create a task */
  54         void (*new_task)(struct event_context *,
  55                          void (*)(struct event_context *, struct server_id, void *),
  56                          void *);
  57
  58         /* function to terminate a connection or task */
  59         void (*terminate)(struct event_context *, const char *reason);
  60
  61         /* function to set a title for the connection or task */
  62         void (*set_title)(struct event_context *, const char *title);
  63 };
  64
  65 /* this structure is used by modules to determine the size of some critical types */
  66 struct process_model_critical_sizes {
  67         int interface_version;
  68         int sizeof_model_ops;
  69 };
  70
  71 #include "smbd/process_model_proto.h"
  72
  73 #endif /* __PROCESS_MODEL_H__ */