mirror of
https://github.com/asterisk/asterisk.git
synced 2026-06-05 13:55:30 +00:00
03090a88ba
This prevents XML documentation duplication by expanding channel and bridge snapshot tags into channel and bridge snapshot parameter sets with a given prefix or defaulting to no prefix. This also prevents documentation from becoming fractured and out of date by keeping all variations of the documentation in template form such that it only needs to be updated once and keeps maintenance to a minimum. Review: https://reviewboard.asterisk.org/r/2708/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@395985 65c4cc65-6c06-0410-ace0-fbb531ad65f3
490 lines
14 KiB
C
490 lines
14 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* Jonathan Rose <jrose@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Confbridge manager events for stasis messages
|
|
*
|
|
* \author Jonathan Rose <jrose@digium.com>
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/bridge.h"
|
|
#include "asterisk/stasis.h"
|
|
#include "asterisk/stasis_channels.h"
|
|
#include "asterisk/stasis_bridges.h"
|
|
#include "asterisk/manager.h"
|
|
#include "asterisk/stasis_message_router.h"
|
|
#include "include/confbridge.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<managerEvent language="en_US" name="ConfbridgeStart">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a conference starts.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeEnd</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeEnd">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a conference ends.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeStart</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeJoin">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a channel joins a Confbridge conference.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
<channel_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeLeave</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeLeave">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a channel leaves a Confbridge conference.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
<channel_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeJoin</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeRecord">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a conference starts recording.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeStopRecord</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeStopRecord">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a conference that was recording stops recording.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeRecord</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeMute">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a Confbridge participant mutes.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
<channel_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeUnmute</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeUnmute">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a confbridge participant unmutes.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
<channel_snapshot/>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="managerEvent">ConfbridgeMute</ref>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
<managerEvent language="en_US" name="ConfbridgeTalking">
|
|
<managerEventInstance class="EVENT_FLAG_CALL">
|
|
<synopsis>Raised when a confbridge participant unmutes.</synopsis>
|
|
<syntax>
|
|
<parameter name="Conference">
|
|
<para>The name of the Confbridge conference.</para>
|
|
</parameter>
|
|
<bridge_snapshot/>
|
|
<channel_snapshot/>
|
|
<parameter name="TalkingStatus">
|
|
<enumlist>
|
|
<enum name="on"/>
|
|
<enum name="off"/>
|
|
</enumlist>
|
|
</parameter>
|
|
</syntax>
|
|
<see-also>
|
|
<ref type="application">ConfBridge</ref>
|
|
</see-also>
|
|
</managerEventInstance>
|
|
</managerEvent>
|
|
***/
|
|
|
|
static struct stasis_message_router *bridge_state_router;
|
|
static struct stasis_message_router *channel_state_router;
|
|
|
|
static void confbridge_publish_manager_event(
|
|
struct stasis_message *message,
|
|
const char *event,
|
|
struct ast_str *extra_text)
|
|
{
|
|
struct ast_bridge_blob *blob = stasis_message_data(message);
|
|
const char *conference_name;
|
|
RAII_VAR(struct ast_str *, bridge_text, NULL, ast_free);
|
|
RAII_VAR(struct ast_str *, channel_text, NULL, ast_free);
|
|
|
|
ast_assert(blob != NULL);
|
|
ast_assert(event != NULL);
|
|
|
|
bridge_text = ast_manager_build_bridge_state_string(blob->bridge, "");
|
|
if (!bridge_text) {
|
|
return;
|
|
}
|
|
|
|
conference_name = ast_json_string_get(ast_json_object_get(blob->blob, "conference"));
|
|
ast_assert(conference_name != NULL);
|
|
|
|
if (blob->channel) {
|
|
channel_text = ast_manager_build_channel_state_string(blob->channel);
|
|
}
|
|
|
|
manager_event(EVENT_FLAG_CALL, event,
|
|
"Conference: %s\r\n"
|
|
"%s"
|
|
"%s"
|
|
"%s",
|
|
conference_name,
|
|
ast_str_buffer(bridge_text),
|
|
S_COR(channel_text, ast_str_buffer(channel_text), ""),
|
|
S_COR(extra_text, ast_str_buffer(extra_text), ""));
|
|
}
|
|
|
|
static void confbridge_start_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeStart", NULL);
|
|
}
|
|
|
|
static void confbridge_end_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeEnd", NULL);
|
|
}
|
|
|
|
static void confbridge_leave_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeLeave", NULL);
|
|
}
|
|
|
|
static void confbridge_join_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeJoin", NULL);
|
|
}
|
|
|
|
static void confbridge_start_record_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeRecord", NULL);
|
|
}
|
|
|
|
static void confbridge_stop_record_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeStopRecord", NULL);
|
|
}
|
|
|
|
static void confbridge_mute_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeMute", NULL);
|
|
}
|
|
|
|
static void confbridge_unmute_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
confbridge_publish_manager_event(message, "ConfbridgeUnmute", NULL);
|
|
}
|
|
|
|
static void confbridge_talking_cb(void *data, struct stasis_subscription *sub,
|
|
struct stasis_topic *topic,
|
|
struct stasis_message *message)
|
|
{
|
|
RAII_VAR(struct ast_str *, extra_text, NULL, ast_free);
|
|
struct ast_bridge_blob *blob = stasis_message_data(message);
|
|
const char *talking_status = ast_json_string_get(ast_json_object_get(blob->blob, "talking_status"));
|
|
if (!talking_status) {
|
|
return;
|
|
}
|
|
|
|
ast_str_append_event_header(&extra_text, "TalkingStatus", talking_status);
|
|
if (!extra_text) {
|
|
return;
|
|
}
|
|
|
|
confbridge_publish_manager_event(message, "ConfbridgeTalking", extra_text);
|
|
}
|
|
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_start_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_end_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_join_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_leave_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_start_record_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_stop_record_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_mute_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_unmute_type);
|
|
STASIS_MESSAGE_TYPE_DEFN(confbridge_talking_type);
|
|
|
|
void manager_confbridge_shutdown(void) {
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_start_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_end_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_join_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_leave_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_start_record_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_stop_record_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_mute_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_unmute_type);
|
|
STASIS_MESSAGE_TYPE_CLEANUP(confbridge_talking_type);
|
|
|
|
if (bridge_state_router) {
|
|
stasis_message_router_unsubscribe(bridge_state_router);
|
|
bridge_state_router = NULL;
|
|
}
|
|
|
|
if (channel_state_router) {
|
|
stasis_message_router_unsubscribe(channel_state_router);
|
|
channel_state_router = NULL;
|
|
}
|
|
}
|
|
|
|
int manager_confbridge_init(void)
|
|
{
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_start_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_end_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_join_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_leave_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_start_record_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_stop_record_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_mute_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_unmute_type);
|
|
STASIS_MESSAGE_TYPE_INIT(confbridge_talking_type);
|
|
|
|
bridge_state_router = stasis_message_router_create(
|
|
ast_bridge_topic_all_cached());
|
|
|
|
if (!bridge_state_router) {
|
|
return -1;
|
|
}
|
|
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_start_type(),
|
|
confbridge_start_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_end_type(),
|
|
confbridge_end_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_join_type(),
|
|
confbridge_join_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_leave_type(),
|
|
confbridge_leave_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_start_record_type(),
|
|
confbridge_start_record_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_stop_record_type(),
|
|
confbridge_stop_record_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_mute_type(),
|
|
confbridge_mute_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_unmute_type(),
|
|
confbridge_unmute_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(bridge_state_router,
|
|
confbridge_talking_type(),
|
|
confbridge_talking_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
|
|
channel_state_router = stasis_message_router_create(
|
|
ast_channel_topic_all_cached());
|
|
|
|
if (!channel_state_router) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_start_type(),
|
|
confbridge_start_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_end_type(),
|
|
confbridge_end_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_join_type(),
|
|
confbridge_join_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_leave_type(),
|
|
confbridge_leave_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_start_record_type(),
|
|
confbridge_start_record_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_stop_record_type(),
|
|
confbridge_stop_record_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_mute_type(),
|
|
confbridge_mute_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_unmute_type(),
|
|
confbridge_unmute_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
if (stasis_message_router_add(channel_state_router,
|
|
confbridge_talking_type(),
|
|
confbridge_talking_cb,
|
|
NULL)) {
|
|
manager_confbridge_shutdown();
|
|
return -1;
|
|
}
|
|
|
|
return 0;
|
|
}
|