Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals

manager.h File Reference

#include <stdarg.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <asterisk/lock.h>

Go to the source code of this file.

Data Structures

struct  mansession
struct  message
struct  manager_action

Defines

#define DEFAULT_MANAGER_PORT   5038
#define EVENT_FLAG_SYSTEM   (1 << 0)
#define EVENT_FLAG_CALL   (1 << 1)
#define EVENT_FLAG_LOG   (1 << 2)
#define EVENT_FLAG_VERBOSE   (1 << 3)
#define EVENT_FLAG_COMMAND   (1 << 4)
#define EVENT_FLAG_AGENT   (1 << 5)
#define EVENT_FLAG_USER   (1 << 6)
#define MAX_HEADERS   80
#define MAX_LEN   256
#define ast_manager_register(a, b, c, d)   ast_manager_register2(a, b, c, d, NULL)

Functions

int ast_carefulwrite (int fd, char *s, int len, int timeoutms)
int ast_manager_register2 (char *action, int authority, int(*func)(struct mansession *s, struct message *m), char *synopsis, char *description)
int ast_manager_unregister (char *action)
int manager_event (int category, char *event, char *contents,...) __attribute__((format(printf
char * astman_get_header (struct message *m, char *var)
void astman_send_error (struct mansession *s, struct message *m, char *error)
void astman_send_response (struct mansession *s, struct message *m, char *resp, char *msg)
void astman_send_ack (struct mansession *s, struct message *m, char *msg)
int init_manager (void)
int reload_manager (void)


Define Documentation

#define ast_manager_register a,
b,
c,
 )     ast_manager_register2(a, b, c, d, NULL)
 

Definition at line 97 of file manager.h.

Referenced by init_manager().

#define DEFAULT_MANAGER_PORT   5038
 

Definition at line 42 of file manager.h.

Referenced by init_manager().

#define EVENT_FLAG_AGENT   (1 << 5)
 

Definition at line 49 of file manager.h.

#define EVENT_FLAG_CALL   (1 << 1)
 

Definition at line 45 of file manager.h.

Referenced by ast_change_name(), ast_channel_bridge(), ast_do_masquerade(), ast_hangup(), ast_pbx_run(), ast_request(), ast_set_callerid(), ast_setstate(), and init_manager().

#define EVENT_FLAG_COMMAND   (1 << 4)
 

Definition at line 48 of file manager.h.

Referenced by init_manager().

#define EVENT_FLAG_LOG   (1 << 2)
 

Definition at line 46 of file manager.h.

#define EVENT_FLAG_SYSTEM   (1 << 0)
 

Definition at line 44 of file manager.h.

Referenced by reload_manager().

#define EVENT_FLAG_USER   (1 << 6)
 

Definition at line 50 of file manager.h.

#define EVENT_FLAG_VERBOSE   (1 << 3)
 

Definition at line 47 of file manager.h.

#define MAX_HEADERS   80
 

Definition at line 53 of file manager.h.

#define MAX_LEN   256
 

Definition at line 54 of file manager.h.


Function Documentation

int ast_carefulwrite int  fd,
char *  s,
int  len,
int  timeoutms
 

Definition at line 82 of file manager.c.

References pollfd::events, pollfd::fd, poll(), POLLOUT, and s.

Referenced by ast_cli(), and manager_event().

00083 { 00084 /* Try to write string, but wait no more than ms milliseconds 00085 before timing out */ 00086 int res=0; 00087 struct pollfd fds[1]; 00088 while(len) { 00089 res = write(fd, s, len); 00090 if ((res < 0) && (errno != EAGAIN)) { 00091 return -1; 00092 } 00093 if (res < 0) res = 0; 00094 len -= res; 00095 s += res; 00096 fds[0].fd = fd; 00097 fds[0].events = POLLOUT; 00098 /* Wait until writable again */ 00099 res = poll(fds, 1, timeoutms); 00100 if (res < 1) 00101 return -1; 00102 } 00103 return res; 00104 }

int ast_manager_register2 char *  action,
int  authority,
int(*  func)(struct mansession *s, struct message *m),
char *  synopsis,
char *  description
 

Definition at line 1294 of file manager.c.

References ast_log(), ast_mutex_unlock, description(), LOG_WARNING, and malloc.

Referenced by init_manager().

01295 { 01296 struct manager_action *cur; 01297 01298 cur = malloc(sizeof(struct manager_action)); 01299 if (!cur) { 01300 ast_log(LOG_WARNING, "Manager: out of memory trying to register action\n"); 01301 ast_mutex_unlock(&actionlock); 01302 return -1; 01303 } 01304 cur->action = action; 01305 cur->authority = auth; 01306 cur->func = func; 01307 cur->synopsis = synopsis; 01308 cur->description = description; 01309 cur->next = NULL; 01310 01311 ast_manager_register_struct(cur); 01312 01313 return 0; 01314 }

int ast_manager_unregister char *  action  ) 
 

Definition at line 1226 of file manager.c.

References ast_mutex_lock, ast_mutex_unlock, ast_verbose(), free, option_verbose, and VERBOSE_PREFIX_2.

01226 { 01227 struct manager_action *cur = first_action, *prev = first_action; 01228 01229 ast_mutex_lock(&actionlock); 01230 while( cur ) { 01231 if (!strcasecmp(action, cur->action)) { 01232 prev->next = cur->next; 01233 free(cur); 01234 if (option_verbose > 1) 01235 ast_verbose(VERBOSE_PREFIX_2 "Manager unregistered action %s\n", action); 01236 ast_mutex_unlock(&actionlock); 01237 return 0; 01238 } 01239 prev = cur; 01240 cur = cur->next; 01241 } 01242 ast_mutex_unlock(&actionlock); 01243 return 0; 01244 }

char* astman_get_header struct message m,
char *  var
 

Definition at line 231 of file manager.c.

References message::hdrcount, and message::headers.

Referenced by astman_send_error(), and astman_send_response().

00232 { 00233 char cmp[80]; 00234 int x; 00235 snprintf(cmp, sizeof(cmp), "%s: ", var); 00236 for (x=0;x<m->hdrcount;x++) 00237 if (!strncasecmp(cmp, m->headers[x], strlen(cmp))) 00238 return m->headers[x] + strlen(cmp); 00239 return ""; 00240 }

void astman_send_ack struct mansession s,
struct message m,
char *  msg
 

Definition at line 267 of file manager.c.

References astman_send_response(), and s.

00268 { 00269 astman_send_response(s, m, "Success", msg); 00270 }

void astman_send_error struct mansession s,
struct message m,
char *  error
 

Definition at line 242 of file manager.c.

References ast_cli(), ast_mutex_lock, ast_mutex_unlock, astman_get_header(), and s.

00243 { 00244 char *id = astman_get_header(m,"ActionID"); 00245 ast_mutex_lock(&s->lock); 00246 ast_cli(s->fd, "Response: Error\r\n"); 00247 if (id && !ast_strlen_zero(id)) 00248 ast_cli(s->fd, "ActionID: %s\r\n",id); 00249 ast_cli(s->fd, "Message: %s\r\n\r\n", error); 00250 ast_mutex_unlock(&s->lock); 00251 }

void astman_send_response struct mansession s,
struct message m,
char *  resp,
char *  msg
 

Definition at line 253 of file manager.c.

References ast_cli(), ast_mutex_lock, ast_mutex_unlock, astman_get_header(), and s.

Referenced by astman_send_ack().

00254 { 00255 char *id = astman_get_header(m,"ActionID"); 00256 ast_mutex_lock(&s->lock); 00257 ast_cli(s->fd, "Response: %s\r\n", resp); 00258 if (id && !ast_strlen_zero(id)) 00259 ast_cli(s->fd, "ActionID: %s\r\n",id); 00260 if (msg) 00261 ast_cli(s->fd, "Message: %s\r\n\r\n", msg); 00262 else 00263 ast_cli(s->fd, "\r\n"); 00264 ast_mutex_unlock(&s->lock); 00265 }

int init_manager void   ) 
 

Definition at line 1318 of file manager.c.

References ast_cli_register(), ast_destroy(), ast_extension_state_add(), ast_load(), ast_log(), ast_manager_register, ast_manager_register2(), ast_true(), ast_variable_retrieve(), ast_verbose(), DEFAULT_MANAGER_PORT, EVENT_FLAG_CALL, EVENT_FLAG_COMMAND, LOG_NOTICE, LOG_WARNING, and option_verbose.

Referenced by main(), and reload_manager().

01319 { 01320 struct ast_config *cfg; 01321 char *val; 01322 int oldportno = portno; 01323 static struct sockaddr_in ba; 01324 int x = 1; 01325 if (!registered) { 01326 /* Register default actions */ 01327 ast_manager_register2("Ping", 0, action_ping, "Ping", mandescr_ping); 01328 ast_manager_register2("Events", 0, action_events, "Contol Event Flow", mandescr_events); 01329 ast_manager_register2("Logoff", 0, action_logoff, "Logoff Manager", mandescr_logoff); 01330 ast_manager_register2("Hangup", EVENT_FLAG_CALL, action_hangup, "Hangup Channel", mandescr_hangup); 01331 ast_manager_register( "Status", EVENT_FLAG_CALL, action_status, "Status" ); 01332 ast_manager_register( "Setvar", EVENT_FLAG_CALL, action_setvar, "Set Channel Variable" ); 01333 ast_manager_register( "Getvar", EVENT_FLAG_CALL, action_getvar, "Gets a Channel Variable" ); 01334 ast_manager_register( "Redirect", EVENT_FLAG_CALL, action_redirect, "Redirect" ); 01335 ast_manager_register2("Originate", EVENT_FLAG_CALL, action_originate, "Originate Call", mandescr_originate); 01336 ast_manager_register( "MailboxStatus", EVENT_FLAG_CALL, action_mailboxstatus, "Check Mailbox" ); 01337 ast_manager_register( "Command", EVENT_FLAG_COMMAND, action_command, "Execute Command" ); 01338 ast_manager_register( "ExtensionState", EVENT_FLAG_CALL, action_extensionstate, "Check Extension Status" ); 01339 ast_manager_register( "AbsoluteTimeout", EVENT_FLAG_CALL, action_timeout, "Set Absolute Timeout" ); 01340 ast_manager_register( "MailboxCount", EVENT_FLAG_CALL, action_mailboxcount, "Check Mailbox Message Count" ); 01341 ast_manager_register2("ListCommands", 0, action_listcommands, "List available manager commands", mandescr_listcommands); 01342 01343 ast_cli_register(&show_mancmd_cli); 01344 ast_cli_register(&show_mancmds_cli); 01345 ast_cli_register(&show_manconn_cli); 01346 ast_extension_state_add(NULL, NULL, manager_state_cb, NULL); 01347 registered = 1; 01348 } 01349 portno = DEFAULT_MANAGER_PORT; 01350 cfg = ast_load("manager.conf"); 01351 if (!cfg) { 01352 ast_log(LOG_NOTICE, "Unable to open management configuration manager.conf. Call management disabled.\n"); 01353 return 0; 01354 } 01355 memset(&ba, 0, sizeof(ba)); 01356 val = ast_variable_retrieve(cfg, "general", "enabled"); 01357 if (val) 01358 enabled = ast_true(val); 01359 01360 val = ast_variable_retrieve(cfg, "general", "block-sockets"); 01361 if(val) 01362 block_sockets = ast_true(val); 01363 01364 if ((val = ast_variable_retrieve(cfg, "general", "port"))) { 01365 if (sscanf(val, "%d", &portno) != 1) { 01366 ast_log(LOG_WARNING, "Invalid port number '%s'\n", val); 01367 portno = DEFAULT_MANAGER_PORT; 01368 } 01369 } else if ((val = ast_variable_retrieve(cfg, "general", "portno"))) { 01370 if (sscanf(val, "%d", &portno) != 1) { 01371 ast_log(LOG_WARNING, "Invalid port number '%s'\n", val); 01372 portno = DEFAULT_MANAGER_PORT; 01373 } 01374 ast_log(LOG_NOTICE, "Use of portno in manager.conf deprecated. Please use 'port=%s' instead.\n", val); 01375 } 01376 01377 ba.sin_family = AF_INET; 01378 ba.sin_port = htons(portno); 01379 memset(&ba.sin_addr, 0, sizeof(ba.sin_addr)); 01380 01381 if ((val = ast_variable_retrieve(cfg, "general", "bindaddr"))) { 01382 if (!inet_aton(val, &ba.sin_addr)) { 01383 ast_log(LOG_WARNING, "Invalid address '%s' specified, using 0.0.0.0\n", val); 01384 memset(&ba.sin_addr, 0, sizeof(ba.sin_addr)); 01385 } 01386 } 01387 01388 if ((asock > -1) && ((portno != oldportno) || !enabled)) { 01389 #if 0 01390 /* Can't be done yet */ 01391 close(asock); 01392 asock = -1; 01393 #else 01394 ast_log(LOG_WARNING, "Unable to change management port / enabled\n"); 01395 #endif 01396 } 01397 ast_destroy(cfg); 01398 01399 /* If not enabled, do nothing */ 01400 if (!enabled) { 01401 return 0; 01402 } 01403 if (asock < 0) { 01404 asock = socket(AF_INET, SOCK_STREAM, 0); 01405 if (asock < 0) { 01406 ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno)); 01407 return -1; 01408 } 01409 setsockopt(asock, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x)); 01410 if (bind(asock, (struct sockaddr *)&ba, sizeof(ba))) { 01411 ast_log(LOG_WARNING, "Unable to bind socket: %s\n", strerror(errno)); 01412 close(asock); 01413 asock = -1; 01414 return -1; 01415 } 01416 if (listen(asock, 2)) { 01417 ast_log(LOG_WARNING, "Unable to listen on socket: %s\n", strerror(errno)); 01418 close(asock); 01419 asock = -1; 01420 return -1; 01421 } 01422 if (option_verbose) 01423 ast_verbose("Asterisk Management interface listening on port %d\n", portno); 01424 pthread_create(&t, NULL, accept_thread, NULL); 01425 } 01426 return 0; 01427 }

int manager_event int  category,
char *  event,
char *  contents,
  ...
 

Referenced by ast_change_name(), ast_channel_bridge(), ast_do_masquerade(), ast_hangup(), ast_pbx_run(), ast_request(), ast_set_callerid(), ast_setstate(), and reload_manager().

int reload_manager void   ) 
 

Definition at line 1429 of file manager.c.

References EVENT_FLAG_SYSTEM, init_manager(), and manager_event().

Referenced by ast_module_reload().

01430 { 01431 manager_event(EVENT_FLAG_SYSTEM, "Reload", "Message: Reload Requested\r\n"); 01432 return init_manager(); 01433 }


Generated on Tue Aug 17 16:13:56 2004 for Asterisk by doxygen 1.3.8