mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-04 03:49:07 +00:00
8d7873b836
This patch adds an /applications API to ARI, allowing explicit management of
Stasis applications.
* GET /applications - list current applications
* GET /applications/{applicationName} - get details of a specific application
* POST /applications/{applicationName}/subscription - explicitly subscribe to
a channel, bridge or endpoint
* DELETE /applications/{applicationName}/subscription - explicitly unsubscribe
from a channel, bridge or endpoint
Subscriptions work by a reference counting mechanism: if you subscript to an
event source X number of times, you must unsubscribe X number of times to stop
receiveing events for that event source.
Review: https://reviewboard.asterisk.org/r/2862
(issue ASTERISK-22451)
Reported by: Matt Jordan
........
Merged revisions 400522 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@400523 65c4cc65-6c06-0410-ace0-fbb531ad65f3
110 lines
3.8 KiB
C
110 lines
3.8 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@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 Generated file - declares stubs to be implemented in
|
|
* res/ari/resource_applications.c
|
|
*
|
|
* Stasis application resources
|
|
*
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
*/
|
|
|
|
/*
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* !!!!! DO NOT EDIT !!!!!
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* This file is generated by a mustache template. Please see the original
|
|
* template in rest-api-templates/ari_resource.h.mustache
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RESOURCE_APPLICATIONS_H
|
|
#define _ASTERISK_RESOURCE_APPLICATIONS_H
|
|
|
|
#include "asterisk/ari.h"
|
|
|
|
/*! \brief Argument struct for ast_ari_get_applications() */
|
|
struct ast_get_applications_args {
|
|
};
|
|
/*!
|
|
* \brief List all applications.
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_get_applications(struct ast_variable *headers, struct ast_get_applications_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_get_application() */
|
|
struct ast_get_application_args {
|
|
/*! \brief Application's name */
|
|
const char *application_name;
|
|
};
|
|
/*!
|
|
* \brief Get details of an application.
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_get_application(struct ast_variable *headers, struct ast_get_application_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_application_subscribe() */
|
|
struct ast_application_subscribe_args {
|
|
/*! \brief Application's name */
|
|
const char *application_name;
|
|
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource} */
|
|
const char **event_source;
|
|
/*! \brief Length of event_source array. */
|
|
size_t event_source_count;
|
|
/*! \brief Parsing context for event_source. */
|
|
char *event_source_parse;
|
|
};
|
|
/*!
|
|
* \brief Subscribe an application to a event source.
|
|
*
|
|
* Returns the state of the application after the subscriptions have changed
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_application_subscribe(struct ast_variable *headers, struct ast_application_subscribe_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_application_unsubscribe() */
|
|
struct ast_application_unsubscribe_args {
|
|
/*! \brief Application's name */
|
|
const char *application_name;
|
|
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource} */
|
|
const char **event_source;
|
|
/*! \brief Length of event_source array. */
|
|
size_t event_source_count;
|
|
/*! \brief Parsing context for event_source. */
|
|
char *event_source_parse;
|
|
};
|
|
/*!
|
|
* \brief Unsubscribe an application from an event source.
|
|
*
|
|
* Returns the state of the application after the subscriptions have changed
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_application_unsubscribe(struct ast_variable *headers, struct ast_application_unsubscribe_args *args, struct ast_ari_response *response);
|
|
|
|
#endif /* _ASTERISK_RESOURCE_APPLICATIONS_H */
|