Asterisk - The Open Source Telephony Project GIT-master-0bf3178
res_manager_devicestate.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2014, Digium, Inc.
5 *
6 * Mark Michelson <mmichelson@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/*** MODULEINFO
20 <support_level>core</support_level>
21 ***/
22
23/*** DOCUMENTATION
24 <manager name="DeviceStateList" language="en_US">
25 <synopsis>
26 List the current known device states.
27 </synopsis>
28 <syntax>
29 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
30 </syntax>
31 <description>
32 <para>This will list out all known device states in a
33 sequence of <replaceable>DeviceStateChange</replaceable> events.
34 When finished, a <replaceable>DeviceStateListComplete</replaceable> event
35 will be emitted.</para>
36 </description>
37 <see-also>
38 <ref type="managerEvent">DeviceStateChange</ref>
39 <ref type="function">DEVICE_STATE</ref>
40 </see-also>
41 <responses>
42 <list-elements>
43 <xi:include xpointer="xpointer(/docs/managerEvent[@name='DeviceStateChange'])" />
44 </list-elements>
45 <managerEvent name="DeviceStateListComplete" language="en_US">
46 <managerEventInstance class="EVENT_FLAG_COMMAND">
47 <synopsis>
48 Indicates the end of the list the current known extension states.
49 </synopsis>
50 <syntax>
51 <parameter name="EventList">
52 <para>Conveys the status of the event list.</para>
53 </parameter>
54 <parameter name="ListItems">
55 <para>Conveys the number of statuses reported.</para>
56 </parameter>
57 </syntax>
58 </managerEventInstance>
59 </managerEvent>
60 </responses>
61 </manager>
62 ***/
63
64
65#include "asterisk.h"
66#include "asterisk/module.h"
67#include "asterisk/manager.h"
68#include "asterisk/stasis.h"
70
72
73static int action_devicestatelist(struct mansession *s, const struct message *m)
74{
75 RAII_VAR(struct ao2_container *, device_states, NULL, ao2_cleanup);
76 const char *action_id = astman_get_header(m, "ActionID");
77 struct stasis_message *msg;
78 struct ao2_iterator it_states;
79 int count = 0;
80
83 if (!device_states) {
84 astman_send_error(s, m, "Memory Allocation Failure");
85 return 0;
86 }
87
88 astman_send_listack(s, m, "Device State Changes will follow", "start");
89
90 it_states = ao2_iterator_init(device_states, 0);
91 for (; (msg = ao2_iterator_next(&it_states)); ao2_ref(msg, -1)) {
93
94 if (!blob) {
95 continue;
96 }
97
98 count++;
99
100 astman_append(s, "Event: %s\r\n", blob->manager_event);
101 if (!ast_strlen_zero(action_id)) {
102 astman_append(s, "ActionID: %s\r\n", action_id);
103 }
104 astman_append(s, "%s\r\n", blob->extra_fields);
105 ao2_ref(blob, -1);
106 }
107 ao2_iterator_destroy(&it_states);
108
109 astman_send_list_complete_start(s, m, "DeviceStateListComplete", count);
111
112 return 0;
113}
114
115static int unload_module(void)
116{
118 ast_manager_unregister("DeviceStateList");
119
120 return 0;
121}
122
123static int load_module(void)
124{
126
128 if (!manager_topic) {
130 }
132 if (!topic_forwarder) {
134 }
135
140 }
141
143}
144
145AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Manager Device State Topic Forwarder",
146 .support_level = AST_MODULE_SUPPORT_CORE,
147 .load = load_module,
148 .unload = unload_module,
Asterisk main include file. File version handling, generic pbx functions.
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
Device state management.
struct stasis_message_type * ast_device_state_message_type(void)
Get the Stasis message type for device state messages.
struct stasis_cache * ast_device_state_cache(void)
Backend cache for ast_device_state_topic_cached()
Definition: devicestate.c:673
struct stasis_topic * ast_device_state_topic_all(void)
Get the Stasis topic for device state messages.
Definition: devicestate.c:668
void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
Send ack in manager transaction to begin a list.
Definition: manager.c:2011
void astman_send_error(struct mansession *s, const struct message *m, char *error)
Send error in manager transaction.
Definition: manager.c:1969
void astman_send_list_complete_start(struct mansession *s, const struct message *m, const char *event_name, int count)
Start the list complete event.
Definition: manager.c:2047
struct stasis_topic * ast_manager_get_topic(void)
Get the Stasis Message Bus API topic for AMI.
Definition: manager.c:453
const char * astman_get_header(const struct message *m, char *var)
Get header from manager transaction.
Definition: manager.c:1630
void astman_send_list_complete_end(struct mansession *s)
End the list complete event.
Definition: manager.c:2055
void astman_append(struct mansession *s, const char *fmt,...)
Definition: manager.c:1890
static struct stasis_topic * manager_topic
A stasis_topic that all topics AMI cares about will be forwarded to.
Definition: manager.c:185
int ast_manager_unregister(const char *action)
Unregister a registered manager command.
Definition: manager.c:7608
The AMI - Asterisk Manager Interface - is a TCP protocol created to manage Asterisk with third-party ...
#define EVENT_FLAG_REPORTING
Definition: manager.h:84
#define ast_manager_register_xml(action, authority, func)
Register a manager callback using XML documentation to describe the manager.
Definition: manager.h:191
#define EVENT_FLAG_CALL
Definition: manager.h:76
Asterisk module definitions.
@ AST_MODFLAG_LOAD_ORDER
Definition: module.h:331
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition: module.h:557
@ AST_MODPRI_DEVSTATE_CONSUMER
Definition: module.h:347
@ AST_MODULE_SUPPORT_CORE
Definition: module.h:121
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
static int action_devicestatelist(struct mansession *s, const struct message *m)
static int load_module(void)
static int unload_module(void)
static struct stasis_forward * topic_forwarder
#define NULL
Definition: resample.c:96
Stasis Message Bus API. See Stasis Message Bus API for detailed documentation.
struct ast_manager_event_blob * stasis_message_to_ami(struct stasis_message *msg)
Build the AMI representation of the message.
struct stasis_forward * stasis_forward_cancel(struct stasis_forward *forward)
Definition: stasis.c:1549
struct ao2_container * stasis_cache_dump_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const struct ast_eid *eid)
Dump cached items to a subscription for a specific entity.
Definition: stasis_cache.c:718
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition: stasis.c:1579
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
Generic container type.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
Struct containing info for an AMI event to send out.
Definition: manager.h:502
const ast_string_field extra_fields
Definition: manager.h:507
const char * manager_event
Definition: manager.h:504
In case you didn't read that giant block of text above the mansession_session struct,...
Definition: manager.c:326
Forwarding information.
Definition: stasis.c:1532
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941