4541e7f173777e0466dd4a4aeee90a3ee1fd0c69
[asterisk/asterisk.git] / include / asterisk / manager.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_MANAGER_H
20 #define _ASTERISK_MANAGER_H
21
22 #include <stdarg.h>
23 #include <sys/types.h>
24 #include <sys/socket.h>
25 #include <netinet/in.h>
26 #include <arpa/inet.h>
27
28 #include "asterisk/lock.h"
29
30 /*!
31  \file
32  \brief The AMI - Asterisk Manager Interface - is a TCP protocol created to
33  manage Asterisk with third-party software.
34
35  Manager protocol packages are text fields of the form a: b.  There is
36  always exactly one space after the colon.
37
38  The first header type is the "Event" header.  Other headers vary from
39  event to event.  Headers end with standard \r\n termination.
40  The last line of the manager response or event is an empty line.
41  (\r\n)
42
43  ** Please try to re-use existing headers to simplify manager message parsing in clients.
44     Don't re-use an existing header with a new meaning, please.
45     You can find a reference of standard headers in doc/manager.txt
46  */
47
48 #define DEFAULT_MANAGER_PORT 5038       /* Default port for Asterisk management via TCP */
49
50 #define EVENT_FLAG_SYSTEM               (1 << 0) /* System events such as module load/unload */
51 #define EVENT_FLAG_CALL                 (1 << 1) /* Call event, such as state change, etc */
52 #define EVENT_FLAG_LOG                  (1 << 2) /* Log events */
53 #define EVENT_FLAG_VERBOSE              (1 << 3) /* Verbose messages */
54 #define EVENT_FLAG_COMMAND              (1 << 4) /* Ability to read/set commands */
55 #define EVENT_FLAG_AGENT                (1 << 5) /* Ability to read/set agent info */
56 #define EVENT_FLAG_USER                 (1 << 6) /* Ability to read/set user info */
57
58 /* Export manager structures */
59 #define AST_MAX_MANHEADERS 80
60 #define AST_MAX_MANHEADER_LEN 256
61
62 struct mansession;
63
64 struct message {
65         int hdrcount;
66         char headers[AST_MAX_MANHEADERS][AST_MAX_MANHEADER_LEN];
67 };
68
69 struct manager_action {
70         /*! Name of the action */
71         const char *action;
72         /*! Short description of the action */
73         const char *synopsis;
74         /*! Detailed description of the action */
75         const char *description;
76         /*! Permission required for action.  EVENT_FLAG_* */
77         int authority;
78         /*! Function to be called */
79         int (*func)(struct mansession *s, struct message *m);
80         /*! For easy linking */
81         struct manager_action *next;
82 };
83
84 int ast_carefulwrite(int fd, char *s, int len, int timeoutms);
85
86 /* External routines may register/unregister manager callbacks this way */
87 #define ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL)
88
89 /* Use ast_manager_register2 to register with help text for new manager commands */
90
91 /*! Register a manager command with the manager interface */
92 /*!     \param action Name of the requested Action:
93         \param authority Required authority for this command
94         \param func Function to call for this command
95         \param synopsis Help text (one line, up to 30 chars) for CLI manager show commands
96         \param description Help text, several lines
97 */
98 int ast_manager_register2(
99         const char *action,
100         int authority,
101         int (*func)(struct mansession *s, struct message *m),
102         const char *synopsis,
103         const char *description);
104
105 /*! Unregister a registred manager command */
106 /*!     \param action Name of registred Action:
107 */
108 int ast_manager_unregister( char *action );
109
110 /*! External routines may send asterisk manager events this way */
111 /*!     \param category Event category, matches manager authorization
112         \param event    Event name
113         \param contents Contents of event
114 */
115 int manager_event(int category, const char *event, const char *contents, ...)
116         __attribute__ ((format (printf, 3,4)));
117
118 /*! Get header from mananger transaction */
119 char *astman_get_header(struct message *m, char *var);
120
121 /*! Get a linked list of the Variable: headers */
122 struct ast_variable *astman_get_variables(struct message *m);
123
124 /*! Send error in manager transaction */
125 void astman_send_error(struct mansession *s, struct message *m, char *error);
126 void astman_send_response(struct mansession *s, struct message *m, char *resp, char *msg);
127 void astman_send_ack(struct mansession *s, struct message *m, char *msg);
128
129 void astman_append(struct mansession *s, const char *fmt, ...)
130         __attribute__ ((format (printf, 2, 3)));
131
132
133 /*! Called by Asterisk initialization */
134 int init_manager(void);
135 /*! Called by Asterisk initialization */
136 int reload_manager(void);
137
138 #endif /* _ASTERISK_MANAGER_H */