include/asterisk/manager.h

   1 /*
   2  * Asterisk -- A telephony toolkit for Linux.
   3  *
   4  * External call management support
   5  *
   6  * Copyright (C) 1999, Mark Spencer
   7  *
   8  * Mark Spencer <markster@linux-support.net>
   9  *
  10  * This program is free software, distributed under the terms of
  11  * the GNU General Public License.
  12  *
  13  * Includes code and algorithms from the Zapata library.
  14  *
  15  */
  16
  17 #ifndef _ASTERISK_MANAGER_H
  18 #define _ASTERISK_MANAGER_H
  19
  20 #include <stdarg.h>
  21 #include <sys/types.h>
  22 #include <sys/socket.h>
  23 #include <netinet/in.h>
  24 #include <arpa/inet.h>
  25
  26 /*
  27  * Call management packages are text fields of the form a: b.  There is
  28  * always exactly one space after the colon.
  29  *
  30  * The first header type is the "Event" header.  Other headers vary from
  31  * event to event.  Headers end with standard \r\n termination.
  32  *
  33  * Some standard headers:
  34  *
  35  * Action: <action>                     -- request or notification of a particular action
  36  * Response: <response>         -- response code, like "200 OK"
  37  *
  38  */
  39
  40 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
  41
  42 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
  43 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
  44 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
  45 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
  46 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
  47 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
  48 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
  49
  50 /* JDG: export manager structures */
  51 #define MAX_HEADERS 80
  52 #define MAX_LEN 256
  53
  54 struct mansession {
  55         pthread_t t;
  56         pthread_mutex_t lock;
  57         struct sockaddr_in sin;
  58         int fd;
  59         int blocking;
  60         char username[80];
  61         char challenge[10];
  62         int authenticated;
  63         int readperm;
  64         int writeperm;
  65         char inbuf[MAX_LEN];
  66         int inlen;
  67
  68         struct mansession *next;
  69 };
  70
  71
  72 struct message {
  73         int hdrcount;
  74         char headers[MAX_HEADERS][MAX_LEN];
  75 };
  76
  77 struct manager_action {
  78         char action[256];
  79         char *synopsis;
  80         int authority;
  81         int (*func)(struct mansession *s, struct message *m);
  82         struct manager_action *next;
  83 };
  84
  85 /* External routines may register/unregister manager callbacks this way */
  86 int ast_manager_register( char *action, int authority,
  87                                          int (*func)(struct mansession *s, struct message *m), char *synopsis);
  88 int ast_manager_unregister( char *action );
  89 /* /JDG */
  90
  91 /* External routines may send asterisk manager events this way */
  92 extern int manager_event(int category, char *event, char *contents, ...)
  93         __attribute__ ((format (printf, 3,4)));
  94
  95 extern char *astman_get_header(struct message *m, char *var);
  96 extern void astman_send_error(struct mansession *s, char *error);
  97 extern void astman_send_response(struct mansession *s, char *resp, char *msg);
  98 extern void astman_send_ack(struct mansession *s, char *msg);
  99
 100 /* Called by Asterisk initialization */
 101 extern int init_manager(void);
 102 extern int reload_manager(void);
 103 #endif