#include "asterisk/network.h"
#include "asterisk/lock.h"
#include "asterisk/datastore.h"
Go to the source code of this file.
Data Structures | |
struct | manager_action |
struct | manager_custom_hook |
struct | message |
Manager event classes | |
#define | EVENT_FLAG_AGENT (1 << 5) |
#define | EVENT_FLAG_AGI (1 << 13) |
#define | EVENT_FLAG_CALL (1 << 1) |
#define | EVENT_FLAG_CDR (1 << 10) |
#define | EVENT_FLAG_COMMAND (1 << 4) |
#define | EVENT_FLAG_CONFIG (1 << 7) |
#define | EVENT_FLAG_DIALPLAN (1 << 11) |
#define | EVENT_FLAG_DTMF (1 << 8) |
#define | EVENT_FLAG_LOG (1 << 2) |
#define | EVENT_FLAG_ORIGINATE (1 << 12) |
#define | EVENT_FLAG_REPORTING (1 << 9) |
#define | EVENT_FLAG_SYSTEM (1 << 0) |
#define | EVENT_FLAG_USER (1 << 6) |
#define | EVENT_FLAG_VERBOSE (1 << 3) |
Defines | |
#define | AMI_VERSION "1.1" |
#define | ast_manager_register(a, b, c, d) ast_manager_register2(a, b, c, d, NULL) |
External routines may register/unregister manager callbacks this way. | |
#define | AST_MAX_MANHEADERS 128 |
Export manager structures. | |
#define | DEFAULT_MANAGER_PORT 5038 |
#define | manager_event(category, event, contents,) __manager_event(category, event, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__) |
External routines may send asterisk manager events this way. | |
Typedefs | |
typedef int(*) | manager_hook_t (int, const char *, char *) |
Manager Helper Function. | |
Functions | |
int | __manager_event (int category, const char *event, const char *file, int line, const char *func, const char *contents,...) |
manager_event: Send AMI event to client | |
int | ast_manager_register2 (const char *action, int authority, int(*func)(struct mansession *s, const struct message *m), const char *synopsis, const char *description) |
Register a manager command with the manager interface. | |
void | ast_manager_register_hook (struct manager_custom_hook *hook) |
Add a custom hook to be called when an event is fired. | |
int | ast_manager_unregister (char *action) |
Unregister a registered manager command. | |
void | ast_manager_unregister_hook (struct manager_custom_hook *hook) |
Delete a custom hook to be called when an event is fired. | |
void | astman_append (struct mansession *s, const char *fmt,...) |
int | astman_datastore_add (struct mansession *s, struct ast_datastore *datastore) |
Add a datastore to a session. | |
ast_datastore * | astman_datastore_find (struct mansession *s, const struct ast_datastore_info *info, const char *uid) |
Find a datastore on a session. | |
int | astman_datastore_remove (struct mansession *s, struct ast_datastore *datastore) |
Remove a datastore from a session. | |
const char * | astman_get_header (const struct message *m, char *var) |
Get header from mananger transaction. | |
ast_variable * | astman_get_variables (const struct message *m) |
Get a linked list of the Variable: headers. | |
int | astman_is_authed (uint32_t ident) |
Determinie if a manager session ident is authenticated. | |
void | astman_send_ack (struct mansession *s, const struct message *m, char *msg) |
Send ack in manager transaction. | |
void | astman_send_error (struct mansession *s, const struct message *m, char *error) |
Send error in manager transaction. | |
void | astman_send_listack (struct mansession *s, const struct message *m, char *msg, char *listflag) |
Send ack in manager list transaction. | |
void | astman_send_response (struct mansession *s, const struct message *m, char *resp, char *msg) |
Send response in manager transaction. | |
int | astman_verify_session_readpermissions (uint32_t ident, int perm) |
Verify a session's read permissions against a permission mask. | |
int | astman_verify_session_writepermissions (uint32_t ident, int perm) |
Verify a session's write permissions against a permission mask. | |
int | check_manager_enabled (void) |
Check if AMI is enabled. | |
int | check_webmanager_enabled (void) |
Check if AMI/HTTP is enabled. | |
int | init_manager (void) |
Called by Asterisk initialization. | |
int | reload_manager (void) |
Called by Asterisk module functions and the CLI command. |
Manager protocol packages are text fields of the form a: b. There is always exactly one space after the colon.
For Actions replies, the first line of the reply is a "Response:" header with values "success", "error" or "follows". "Follows" implies that the response is coming as separate events with the same ActionID. If the Action request has no ActionID, it will be hard matching events to the Action request in the manager client. The first header type is the "Event" header. Other headers vary from event to event. Headers end with standard \\r\\n termination. The last line of the manager response or event is an empty line. (\\r\\n)
Definition in file manager.h.
#define AMI_VERSION "1.1" |
#define ast_manager_register | ( | a, | |||
b, | |||||
c, | |||||
d | ) | ast_manager_register2(a, b, c, d, NULL) |
External routines may register/unregister manager callbacks this way.
Definition at line 133 of file manager.h.
Referenced by ast_features_init(), astdb_init(), and load_module().
#define AST_MAX_MANHEADERS 128 |
#define DEFAULT_MANAGER_PORT 5038 |
#define EVENT_FLAG_AGENT (1 << 5) |
Definition at line 66 of file manager.h.
Referenced by add_to_queue(), agent_logoff_maintenance(), load_module(), login_exec(), record_abandoned(), remove_from_queue(), ring_entry(), rna(), send_agent_complete(), set_member_paused(), set_member_penalty(), try_calling(), and update_status().
#define EVENT_FLAG_AGI (1 << 13) |
Definition at line 74 of file manager.h.
Referenced by agi_handle_command(), launch_asyncagi(), and load_module().
#define EVENT_FLAG_CALL (1 << 1) |
Definition at line 62 of file manager.h.
Referenced by __init_manager(), ast_cdr_setaccount(), ast_change_name(), ast_channel_alloc(), ast_channel_bridge(), ast_do_masquerade(), ast_features_init(), ast_hangup(), ast_monitor_start(), ast_monitor_stop(), ast_park_call_full(), ast_set_callerid(), ast_setstate(), bridge_exec(), conf_free(), conf_run(), fast_originate(), handle_request_refer(), join_queue(), leave_queue(), load_module(), local_ast_moh_stop(), local_attended_transfer(), manager_bridge_event(), manager_state_cb(), notify_new_message(), park_exec_full(), phase_e_handler(), post_manager_event(), process_sdp(), senddialendevent(), senddialevent(), socket_process(), and vm_execmain().
#define EVENT_FLAG_CDR (1 << 10) |
#define EVENT_FLAG_COMMAND (1 << 4) |
#define EVENT_FLAG_CONFIG (1 << 7) |
Definition at line 68 of file manager.h.
Referenced by __init_manager(), load_pbx(), and manager_show_dialplan().
#define EVENT_FLAG_DIALPLAN (1 << 11) |
Definition at line 72 of file manager.h.
Referenced by frame_set_var(), pbx_builtin_setvar_helper(), pbx_extension_helper(), and shared_write().
#define EVENT_FLAG_DTMF (1 << 8) |
#define EVENT_FLAG_ORIGINATE (1 << 12) |
#define EVENT_FLAG_REPORTING (1 << 9) |
Definition at line 70 of file manager.h.
Referenced by __init_manager(), ast_rtcp_read(), ast_rtcp_write_sr(), ast_rtp_destroy(), astdb_init(), load_module(), load_pbx(), and log_jitterstats().
#define EVENT_FLAG_SYSTEM (1 << 0) |
Definition at line 61 of file manager.h.
Referenced by __expire_registry(), __iax2_poke_noanswer(), __init_manager(), action_originate(), astdb_init(), dahdi_dnd(), dahdi_handle_event(), do_reload(), expire_register(), gtalk_answer(), gtalk_new(), handle_alarms(), handle_init_event(), handle_response_invite(), handle_response_peerpoke(), handle_response_register(), iax2_ack_registry(), iax2_ami_channelupdate(), load_module(), logger_print_normal(), mwi_thread(), parse_register_contact(), private_enum_init(), quit_handler(), register_verify(), reload_logger(), sip_new(), sip_poke_noanswer(), sip_reg_timeout(), sip_request_call(), socket_process(), and update_registry().
#define EVENT_FLAG_USER (1 << 6) |
Definition at line 67 of file manager.h.
Referenced by __init_manager(), action_userevent(), aji_log_hook(), and userevent_exec().
#define manager_event | ( | category, | |||
event, | |||||
contents | ) | __manager_event(category, event, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__) |
External routines may send asterisk manager events this way.
category | Event category, matches manager authorization | |
event | Event name | |
contents | Contents of event |
Definition at line 181 of file manager.h.
Referenced by __expire_registry(), __iax2_poke_noanswer(), action_userevent(), add_to_queue(), agent_logoff_maintenance(), agi_handle_command(), aji_log_hook(), ast_cdr_setaccount(), ast_change_name(), ast_channel_alloc(), ast_channel_bridge(), ast_do_masquerade(), ast_hangup(), ast_monitor_start(), ast_monitor_stop(), ast_park_call_full(), ast_rtcp_read(), ast_rtcp_write_sr(), ast_rtp_destroy(), ast_set_callerid(), ast_setstate(), bridge_exec(), conf_free(), conf_run(), dahdi_dnd(), dahdi_handle_event(), do_reload(), expire_register(), fast_originate(), frame_set_var(), gtalk_answer(), gtalk_new(), handle_alarms(), handle_init_event(), handle_request_refer(), handle_response_invite(), handle_response_peerpoke(), handle_response_register(), iax2_ack_registry(), iax2_ami_channelupdate(), join_queue(), launch_asyncagi(), leave_queue(), local_ast_moh_stop(), local_attended_transfer(), log_jitterstats(), logger_print_normal(), login_exec(), manager_bridge_event(), manager_log(), manager_show_dialplan(), manager_state_cb(), mwi_thread(), notify_new_message(), park_exec_full(), parse_register_contact(), pbx_builtin_setvar_helper(), pbx_extension_helper(), phase_e_handler(), post_manager_event(), private_enum_init(), process_sdp(), quit_handler(), record_abandoned(), register_verify(), reload_logger(), remove_from_queue(), ring_entry(), rna(), send_agent_complete(), send_dtmf_event(), senddialendevent(), senddialevent(), set_member_paused(), set_member_penalty(), shared_write(), sip_new(), sip_poke_noanswer(), sip_reg_timeout(), sip_request_call(), socket_process(), try_calling(), update_registry(), update_status(), userevent_exec(), and vm_execmain().
typedef int(*) manager_hook_t(int, const char *, char *) |
int astman_datastore_add | ( | struct mansession * | s, | |
struct ast_datastore * | datastore | |||
) |
Add a datastore to a session.
0 | success | |
non-zero | failure |
Definition at line 4341 of file manager.c.
References AST_LIST_INSERT_HEAD, and s.
04342 { 04343 AST_LIST_INSERT_HEAD(&s->session->datastores, datastore, entry); 04344 04345 return 0; 04346 }
struct ast_datastore* astman_datastore_find | ( | struct mansession * | s, | |
const struct ast_datastore_info * | info, | |||
const char * | uid | |||
) |
Find a datastore on a session.
pointer | to the datastore if found | |
NULL | if not found |
Definition at line 4353 of file manager.c.
References AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_datastore::info, s, and ast_datastore::uid.
04354 { 04355 struct ast_datastore *datastore = NULL; 04356 04357 if (info == NULL) 04358 return NULL; 04359 04360 AST_LIST_TRAVERSE_SAFE_BEGIN(&s->session->datastores, datastore, entry) { 04361 if (datastore->info != info) { 04362 continue; 04363 } 04364 04365 if (uid == NULL) { 04366 /* matched by type only */ 04367 break; 04368 } 04369 04370 if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) { 04371 /* Matched by type AND uid */ 04372 break; 04373 } 04374 } 04375 AST_LIST_TRAVERSE_SAFE_END; 04376 04377 return datastore; 04378 }
int astman_datastore_remove | ( | struct mansession * | s, | |
struct ast_datastore * | datastore | |||
) |
Remove a datastore from a session.
0 | success | |
non-zero | failure |
Definition at line 4348 of file manager.c.
References AST_LIST_REMOVE, and s.
04349 { 04350 return AST_LIST_REMOVE(&s->session->datastores, datastore, entry) ? 0 : -1; 04351 }
int astman_is_authed | ( | uint32_t | ident | ) |
Determinie if a manager session ident is authenticated.
Definition at line 3480 of file manager.c.
References mansession_session::__lock, ast_mutex_unlock(), mansession_session::authenticated, and find_session().
Referenced by handle_uri(), and static_callback().
03481 { 03482 int authed; 03483 struct mansession_session *session; 03484 03485 if (!(session = find_session(ident, 0))) 03486 return 0; 03487 03488 authed = (session->authenticated != 0); 03489 03490 ast_mutex_unlock(&session->__lock); 03491 03492 return authed; 03493 }
int astman_verify_session_readpermissions | ( | uint32_t | ident, | |
int | perm | |||
) |
Verify a session's read permissions against a permission mask.
ident | session identity | |
perm | permission mask to verify |
1 | if the session has the permission mask capabilities | |
0 | otherwise |
Definition at line 3495 of file manager.c.
References mansession_session::__lock, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), mansession_session::managerid, and mansession_session::readperm.
03496 { 03497 int result = 0; 03498 struct mansession_session *session; 03499 03500 AST_LIST_LOCK(&sessions); 03501 AST_LIST_TRAVERSE(&sessions, session, list) { 03502 ast_mutex_lock(&session->__lock); 03503 if ((session->managerid == ident) && (session->readperm & perm)) { 03504 result = 1; 03505 ast_mutex_unlock(&session->__lock); 03506 break; 03507 } 03508 ast_mutex_unlock(&session->__lock); 03509 } 03510 AST_LIST_UNLOCK(&sessions); 03511 return result; 03512 }
int astman_verify_session_writepermissions | ( | uint32_t | ident, | |
int | perm | |||
) |
Verify a session's write permissions against a permission mask.
ident | session identity | |
perm | permission mask to verify |
1 | if the session has the permission mask capabilities, otherwise 0 | |
0 | otherwise |
Definition at line 3514 of file manager.c.
References mansession_session::__lock, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), mansession_session::managerid, and mansession_session::writeperm.
03515 { 03516 int result = 0; 03517 struct mansession_session *session; 03518 03519 AST_LIST_LOCK(&sessions); 03520 AST_LIST_TRAVERSE(&sessions, session, list) { 03521 ast_mutex_lock(&session->__lock); 03522 if ((session->managerid == ident) && (session->writeperm & perm)) { 03523 result = 1; 03524 ast_mutex_unlock(&session->__lock); 03525 break; 03526 } 03527 ast_mutex_unlock(&session->__lock); 03528 } 03529 AST_LIST_UNLOCK(&sessions); 03530 return result; 03531 }
int init_manager | ( | void | ) |
Called by Asterisk initialization.
Definition at line 4331 of file manager.c.
References __init_manager().
Referenced by main().
04332 { 04333 return __init_manager(0); 04334 }
int reload_manager | ( | void | ) |
Called by Asterisk module functions and the CLI command.
Definition at line 4336 of file manager.c.
References __init_manager().
Referenced by handle_manager_reload().
04337 { 04338 return __init_manager(1); 04339 }