mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 11:25:35 +00:00
2a55f064f3
This commit adds the ability to make ARI REST requests over the same
websocket used to receive events.
For full details on how to use the new capability, visit...
https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/
Changes:
* Added utilities to http.c:
* ast_get_http_method_from_string().
* ast_http_parse_post_form().
* Added utilities to json.c:
* ast_json_nvp_array_to_ast_variables().
* ast_variables_to_json_nvp_array().
* Added definitions for new events to carry REST responses.
* Created res/ari/ari_websocket_requests.c to house the new request handlers.
* Moved non-event specific code out of res/ari/resource_events.c into
res/ari/ari_websockets.c
* Refactored res/res_ari.c to move non-http code out of ast_ari_callback()
(which is http specific) and into ast_ari_invoke() so it can be shared
between both the http and websocket transports.
UpgradeNote: This commit adds the ability to make ARI REST requests over the same
websocket used to receive events.
See https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/
(cherry picked from commit 1442c17141)
89 lines
3.0 KiB
C
89 lines
3.0 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2012 - 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_events.c
|
|
*
|
|
* WebSocket resource
|
|
*
|
|
* \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_EVENTS_H
|
|
#define _ASTERISK_RESOURCE_EVENTS_H
|
|
|
|
#include "asterisk/ari.h"
|
|
|
|
/*! Argument struct for ast_ari_events_event_websocket() */
|
|
struct ast_ari_events_event_websocket_args {
|
|
/*! Array of Applications to subscribe to. */
|
|
const char **app;
|
|
/*! Length of app array. */
|
|
size_t app_count;
|
|
/*! Parsing context for app. */
|
|
char *app_parse;
|
|
/*! Subscribe to all Asterisk events. If provided, the applications listed will be subscribed to all events, effectively disabling the application specific subscriptions. Default is 'false'. */
|
|
int subscribe_all;
|
|
};
|
|
/*! Argument struct for ast_ari_events_user_event() */
|
|
struct ast_ari_events_user_event_args {
|
|
/*! Event name */
|
|
const char *event_name;
|
|
/*! The name of the application that will receive this event */
|
|
const char *application;
|
|
/*! Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
|
|
const char **source;
|
|
/*! Length of source array. */
|
|
size_t source_count;
|
|
/*! Parsing context for source. */
|
|
char *source_parse;
|
|
/*! The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } } */
|
|
struct ast_json *variables;
|
|
};
|
|
/*!
|
|
* \brief Body parsing function for /events/user/{eventName}.
|
|
* \param body The JSON body from which to parse parameters.
|
|
* \param[out] args The args structure to parse into.
|
|
* \retval zero on success
|
|
* \retval non-zero on failure
|
|
*/
|
|
int ast_ari_events_user_event_parse_body(
|
|
struct ast_json *body,
|
|
struct ast_ari_events_user_event_args *args);
|
|
|
|
/*!
|
|
* \brief Generate a user event.
|
|
*
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
void ast_ari_events_user_event(struct ast_variable *headers, struct ast_ari_events_user_event_args *args, struct ast_ari_response *response);
|
|
|
|
#endif /* _ASTERISK_RESOURCE_EVENTS_H */
|