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.
156 lines
4.0 KiB
156 lines
4.0 KiB
/*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RES_STASIS_APP_H
|
|
#define _ASTERISK_RES_STASIS_APP_H
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Internal API for the Stasis application controller.
|
|
*
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
* \since 12
|
|
*/
|
|
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/stasis.h"
|
|
#include "asterisk/stasis_app.h"
|
|
|
|
/*!
|
|
* \brief Opaque pointer to \c res_stasis app structure.
|
|
*/
|
|
struct app;
|
|
|
|
/*!
|
|
* \brief Create a res_stasis application.
|
|
*
|
|
* \param name Name of the application.
|
|
* \param handler Callback for messages sent to the application.
|
|
* \param data Data pointer provided to the callback.
|
|
* \return New \c res_stasis application.
|
|
* \return \c NULL on error.
|
|
*/
|
|
struct app *app_create(const char *name, stasis_app_cb handler, void *data);
|
|
|
|
/*!
|
|
* \brief Tears down an application.
|
|
*
|
|
* It should be finished before calling this.
|
|
*
|
|
* \param app Application to unsubscribe.
|
|
*/
|
|
void app_shutdown(struct app *app);
|
|
|
|
/*!
|
|
* \brief Deactivates an application.
|
|
*
|
|
* Any channels currently in the application remain active (since the app might
|
|
* come back), but new channels are rejected.
|
|
*
|
|
* \param app Application to deactivate.
|
|
*/
|
|
void app_deactivate(struct app *app);
|
|
|
|
/*!
|
|
* \brief Checks whether an app is active.
|
|
*
|
|
* \param app Application to check.
|
|
* \return True (non-zero) if app is active.
|
|
* \return False (zero) if app has been deactivated.
|
|
*/
|
|
int app_is_active(struct app *app);
|
|
|
|
/*!
|
|
* \brief Checks whether a deactivated app has no channels.
|
|
*
|
|
* \param app Application to check.
|
|
* \param True (non-zero) if app is deactivated, and has no associated channels.
|
|
* \param False (zero) otherwise.
|
|
*/
|
|
int app_is_finished(struct app *app);
|
|
|
|
/*!
|
|
* \brief Update the handler and data for a \c res_stasis application.
|
|
*
|
|
* If app has been deactivated, this will reactivate it.
|
|
*
|
|
* \param app Application to update.
|
|
* \param handler New application callback.
|
|
* \param data New data pointer for the callback.
|
|
*/
|
|
void app_update(struct app *app, stasis_app_cb handler, void *data);
|
|
|
|
/*!
|
|
* \brief Return an application's name.
|
|
*
|
|
* \param app Application.
|
|
* \return Name of the application.
|
|
* \return \c NULL is \a app is \c NULL.
|
|
*/
|
|
const char *app_name(const struct app *app);
|
|
|
|
/*!
|
|
* \brief Send a message to an application.
|
|
*
|
|
* \param app Application.
|
|
* \param message Message to send.
|
|
*/
|
|
void app_send(struct app *app, struct ast_json *message);
|
|
|
|
struct app_forwards;
|
|
|
|
/*!
|
|
* \brief Subscribes an application to a channel.
|
|
*
|
|
* \param app Application.
|
|
* \param chan Channel to subscribe to.
|
|
* \return 0 on success.
|
|
* \return Non-zero on error.
|
|
*/
|
|
int app_subscribe_channel(struct app *app, struct ast_channel *chan);
|
|
|
|
/*!
|
|
* \brief Cancel the subscription an app has for a channel.
|
|
*
|
|
* \param app Subscribing application.
|
|
* \param forwards Returned object from app_subscribe_channel().
|
|
*/
|
|
int app_unsubscribe_channel(struct app *app, struct ast_channel *chan);
|
|
|
|
/*!
|
|
* \brief Add a bridge subscription to an existing channel subscription.
|
|
*
|
|
* \param app Application.
|
|
* \param bridge Bridge to subscribe to.
|
|
* \return 0 on success.
|
|
* \return Non-zero on error.
|
|
*/
|
|
int app_subscribe_bridge(struct app *app, struct ast_bridge *bridge);
|
|
|
|
/*!
|
|
* \brief Cancel the bridge subscription for an application.
|
|
*
|
|
* \param forwards Return from app_subscribe_channel().
|
|
* \param bridge Bridge to subscribe to.
|
|
* \return 0 on success.
|
|
* \return Non-zero on error.
|
|
*/
|
|
int app_unsubscribe_bridge(struct app *app, struct ast_bridge *bridge);
|
|
|
|
#endif /* _ASTERISK_RES_STASIS_APP_H */
|