mirror of https://github.com/asterisk/asterisk
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
141 lines
4.2 KiB
141 lines
4.2 KiB
/*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef _ASTERISK_APP_STASIS_H
|
|
#define _ASTERISK_APP_STASIS_H
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Stasis Application API. See \ref app_stasis "Stasis Application API"
|
|
* for detailed documentation.
|
|
*
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
* \since 12
|
|
*
|
|
* \page app_stasis Stasis Application API
|
|
*
|
|
* This is the API that binds the Stasis dialplan application to external
|
|
* Stasis applications, such as \c res_stasis_websocket.
|
|
*
|
|
* This module registers a dialplan function named \c Stasis, which is used to
|
|
* put a channel into the named Stasis app. As a channel enters and leaves the
|
|
* Stasis diaplan applcation, the Stasis app receives a \c 'stasis-start' and \c
|
|
* 'stasis-end' events.
|
|
*
|
|
* Stasis apps register themselves using the \ref stasis_app_register and
|
|
* stasis_app_unregister functions. Messages are sent to an appliction using
|
|
* \ref stasis_app_send.
|
|
*
|
|
* Finally, Stasis apps control channels through the use of the \ref
|
|
* stasis_app_control object, and the family of \c stasis_app_control_*
|
|
* functions.
|
|
*/
|
|
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/json.h"
|
|
|
|
struct ast_channel_snapshot;
|
|
|
|
/*! @{ */
|
|
|
|
/*!
|
|
* \brief Callback for Stasis application handler.
|
|
*
|
|
* The message given to the handler is a borrowed copy. If you want to keep a
|
|
* reference to it, you should use \c ao2_ref() to keep it around.
|
|
*
|
|
* \param data Data ptr given when registered.
|
|
* \param app_name Name of the application being dispatched to.
|
|
* \param message Message to handle. (borrowed copy)
|
|
*/
|
|
typedef void (*stasis_app_cb)(void *data, const char *app_name,
|
|
struct ast_json *message);
|
|
|
|
/*!
|
|
* \brief Register a new Stasis application.
|
|
*
|
|
* If an application is already registered with the given name, the old
|
|
* application is sent a 'replaced' message and unregistered.
|
|
*
|
|
* \param app_name Name of this application.
|
|
* \param handler Callback for application messages.
|
|
* \param data Data blob to pass to the callback. Must be AO2 managed.
|
|
* \return 0 for success
|
|
* \return -1 for error.
|
|
*/
|
|
int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data);
|
|
|
|
/*!
|
|
* \brief Unregister a Stasis application.
|
|
* \param app_name Name of the application to unregister.
|
|
*/
|
|
void stasis_app_unregister(const char *app_name);
|
|
|
|
/*!
|
|
* \brief Send a message to the given Stasis application.
|
|
*
|
|
* The message given to the handler is a borrowed copy. If you want to keep a
|
|
* reference to it, you should use \c ao2_ref() to keep it around.
|
|
*
|
|
* \param app_name Name of the application to invoke.
|
|
* \param message Message to send (borrowed reference)
|
|
* \return 0 for success.
|
|
* \return -1 for error.
|
|
*/
|
|
int stasis_app_send(const char *app_name, struct ast_json *message);
|
|
|
|
/*! @} */
|
|
|
|
/*! @{ */
|
|
|
|
/*! \brief Handler for controlling a channel that's in a Stasis application */
|
|
struct stasis_app_control;
|
|
|
|
/*!
|
|
* \brief Returns the handler for the given channel
|
|
* \param chan Channel to handle.
|
|
* \return NULL channel not in Stasis application
|
|
* \return Pointer to app_stasis handler.
|
|
*/
|
|
struct stasis_app_control *stasis_app_control_find_by_channel(
|
|
const struct ast_channel *chan);
|
|
|
|
/*!
|
|
* \brief Exit \c app_stasis and continue execution in the dialplan.
|
|
*
|
|
* If the channel is no longer in \c app_stasis, this function does nothing.
|
|
*
|
|
* \param handler Handler for \c app_stasis
|
|
*/
|
|
void stasis_app_control_continue(struct stasis_app_control *handler);
|
|
|
|
/*! @} */
|
|
|
|
/*! @{ */
|
|
|
|
/*!
|
|
* \brief Build a JSON object from a \ref ast_channel_snapshot.
|
|
* \return JSON object representing channel snapshot.
|
|
* \return \c NULL on error
|
|
*/
|
|
struct ast_json *ast_channel_snapshot_to_json(const struct ast_channel_snapshot *snapshot);
|
|
|
|
/*! @} */
|
|
|
|
#endif /* _ASTERISK_APP_STASIS_H */
|