mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-04 05:15:22 +00:00
ed48377994
Created a data model and implemented functionality for an ARI device state
resource. The following operations have been added that allow a user to
manipulate an ARI controlled device:
Create/Change the state of an ARI controlled device
PUT /deviceStates/{deviceName}&{deviceState}
Retrieve all ARI controlled devices
GET /deviceStates
Retrieve the current state of a device
GET /deviceStates/{deviceName}
Destroy a device-state controlled by ARI
DELETE /deviceStates/{deviceName}
The ARI controlled device must begin with 'Stasis:'. An example controlled
device name would be Stasis:Example. A 'DeviceStateChanged' event has also
been added so that an application can subscribe and receive device change
events. Any device state, ARI controlled or not, can be subscribed to.
While adding the event, the underlying subscription control mechanism was
refactored so that all current and future resource subscriptions would be
the same. Each event resource must now register itself in order to be able
to properly handle [un]subscribes.
(issue ASTERISK-22838)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/3025/
........
Merged revisions 403134 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403135 65c4cc65-6c06-0410-ace0-fbb531ad65f3
110 lines
3.9 KiB
C
110 lines
3.9 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_applications_list() */
|
|
struct ast_ari_applications_list_args {
|
|
};
|
|
/*!
|
|
* \brief List all applications.
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_applications_list(struct ast_variable *headers, struct ast_ari_applications_list_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_applications_get() */
|
|
struct ast_ari_applications_get_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_applications_get(struct ast_variable *headers, struct ast_ari_applications_get_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_applications_subscribe() */
|
|
struct ast_ari_applications_subscribe_args {
|
|
/*! \brief Application's name */
|
|
const char *application_name;
|
|
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
|
|
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_applications_subscribe(struct ast_variable *headers, struct ast_ari_applications_subscribe_args *args, struct ast_ari_response *response);
|
|
/*! \brief Argument struct for ast_ari_applications_unsubscribe() */
|
|
struct ast_ari_applications_unsubscribe_args {
|
|
/*! \brief Application's name */
|
|
const char *application_name;
|
|
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, device_state:{deviceName} */
|
|
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_applications_unsubscribe(struct ast_variable *headers, struct ast_ari_applications_unsubscribe_args *args, struct ast_ari_response *response);
|
|
|
|
#endif /* _ASTERISK_RESOURCE_APPLICATIONS_H */
|