ac3a2b2dca2f8d35bcbb472fc1a8284c343a6d30
[asterisk/asterisk.git] / 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 #include <asterisk/lock.h>
27
28 /* 
29  * Call management packages are text fields of the form a: b.  There is
30  * always exactly one space after the colon.
31  *
32  * The first header type is the "Event" header.  Other headers vary from
33  * event to event.  Headers end with standard \r\n termination.
34  *
35  * Some standard headers:
36  *
37  * Action: <action>                     -- request or notification of a particular action
38  * Response: <response>         -- response code, like "200 OK"
39  *
40  */
41  
42 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
43
44 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
45 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
46 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
47 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
48 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
49 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
50 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
51
52 /* JDG: export manager structures */
53 #define MAX_HEADERS 80
54 #define MAX_LEN 256
55
56 struct mansession {
57         pthread_t t;
58         ast_mutex_t lock;
59         struct sockaddr_in sin;
60         int fd;
61         int blocking;
62         char username[80];
63         char challenge[10];
64         int authenticated;
65         int readperm;
66         int writeperm;
67         char inbuf[MAX_LEN];
68         int inlen;
69         
70         struct mansession *next;
71 };
72
73
74 struct message {
75         int hdrcount;
76         char headers[MAX_HEADERS][MAX_LEN];
77 };
78
79 struct manager_action {
80         char action[256];
81         char *synopsis;
82         int authority;
83         int (*func)(struct mansession *s, struct message *m);
84         struct manager_action *next;
85 };
86
87 /* External routines may register/unregister manager callbacks this way */
88 int ast_manager_register( char *action, int authority, 
89                                          int (*func)(struct mansession *s, struct message *m), char *synopsis);
90 int ast_manager_unregister( char *action );
91 /* /JDG */
92
93 /* External routines may send asterisk manager events this way */
94 extern int manager_event(int category, char *event, char *contents, ...)
95         __attribute__ ((format (printf, 3,4)));
96
97 extern char *astman_get_header(struct message *m, char *var);
98 extern void astman_send_error(struct mansession *s, struct message *m, char *error);
99 extern void astman_send_response(struct mansession *s, struct message *m, char *resp, char *msg);
100 extern void astman_send_ack(struct mansession *s, struct message *m, char *msg);
101
102 /* Called by Asterisk initialization */
103 extern int init_manager(void);
104 extern int reload_manager(void);
105 #endif