mirror of
https://github.com/asterisk/asterisk.git
synced 2025-12-02 03:02:05 +00:00
Merge in the bridge_construction branch to make the system use the Bridging API.
Breaks many things until they can be reworked. A partial list: chan_agent chan_dahdi, chan_misdn, chan_iax2 native bridging app_queue COLP updates DTMF attended transfers Protocol attended transfers git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@389378 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Richard Mudgett
191
include/asterisk/core_unreal.h
Normal file
191
include/asterisk/core_unreal.h
Normal file
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
* Asterisk -- An open source telephony toolkit.
|
||||
*
|
||||
* Copyright (C) 2013 Digium, Inc.
|
||||
*
|
||||
* Richard Mudgett <rmudgett@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 Unreal channel derivative framework.
|
||||
*
|
||||
* \author Richard Mudgett <rmudgett@digium.com>
|
||||
*
|
||||
* See Also:
|
||||
* \arg \ref AstCREDITS
|
||||
*/
|
||||
|
||||
#ifndef _ASTERISK_CORE_UNREAL_H
|
||||
#define _ASTERISK_CORE_UNREAL_H
|
||||
|
||||
#include "asterisk/astobj2.h"
|
||||
#include "asterisk/channel.h"
|
||||
#include "asterisk/abstract_jb.h"
|
||||
|
||||
#if defined(__cplusplus) || defined(c_plusplus)
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* Forward declare some struct names */
|
||||
struct ast_format_cap;
|
||||
struct ast_callid;
|
||||
|
||||
/* ------------------------------------------------------------------- */
|
||||
|
||||
/*!
|
||||
* \brief The base pvt structure for local channel derivatives.
|
||||
*
|
||||
* The unreal pvt has two ast_chan objects - the "owner" and the "next channel", the outbound channel
|
||||
*
|
||||
* ast_chan owner -> ast_unreal_pvt -> ast_chan chan
|
||||
*/
|
||||
struct ast_unreal_pvt {
|
||||
struct ast_channel *owner; /*!< Master Channel - ;1 side */
|
||||
struct ast_channel *chan; /*!< Outbound channel - ;2 side */
|
||||
struct ast_format_cap *reqcap; /*!< Requested format capabilities */
|
||||
struct ast_jb_conf jb_conf; /*!< jitterbuffer configuration */
|
||||
unsigned int flags; /*!< Private option flags */
|
||||
/*! Base name of the unreal channels. exten@context or other name. */
|
||||
char name[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2];
|
||||
};
|
||||
|
||||
#define AST_UNREAL_IS_OUTBOUND(a, b) ((a) == (b)->chan ? 1 : 0)
|
||||
|
||||
#define AST_UNREAL_CARETAKER_THREAD (1 << 0) /*!< The ;2 side launched a PBX, was pushed into a bridge, or was masqueraded into an application. */
|
||||
#define AST_UNREAL_NO_OPTIMIZATION (1 << 1) /*!< Do not optimize out the unreal channels */
|
||||
#define AST_UNREAL_MOH_INTERCEPT (1 << 2) /*!< Intercept and act on hold/unhold control frames */
|
||||
|
||||
/*!
|
||||
* \brief Send an unreal pvt in with no locks held and get all locks
|
||||
*
|
||||
* \note NO locks should be held prior to calling this function
|
||||
* \note The pvt must have a ref held before calling this function
|
||||
* \note if outchan or outowner is set != NULL after calling this function
|
||||
* those channels are locked and reffed.
|
||||
* \note Batman.
|
||||
*/
|
||||
void ast_unreal_lock_all(struct ast_unreal_pvt *p, struct ast_channel **outchan, struct ast_channel **outowner);
|
||||
|
||||
/*!
|
||||
* \brief Hangup one end (maybe both ends) of an unreal channel derivative.
|
||||
* \since 12.0.0
|
||||
*
|
||||
* \param p Private channel struct (reffed)
|
||||
* \param ast Channel being hung up. (locked)
|
||||
*
|
||||
* \note Common hangup code for unreal channels. Derived
|
||||
* channels will need to deal with any additional resources.
|
||||
*
|
||||
* \retval 0 on success.
|
||||
* \retval -1 on error.
|
||||
*/
|
||||
int ast_unreal_hangup(struct ast_unreal_pvt *p, struct ast_channel *ast);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.send_digit_begin callback */
|
||||
int ast_unreal_digit_begin(struct ast_channel *ast, char digit);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.send_digit_end callback */
|
||||
int ast_unreal_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.answer callback */
|
||||
int ast_unreal_answer(struct ast_channel *ast);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.read and struct ast_channel_tech.exception callback */
|
||||
struct ast_frame *ast_unreal_read(struct ast_channel *ast);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.write callback */
|
||||
int ast_unreal_write(struct ast_channel *ast, struct ast_frame *f);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.indicate callback */
|
||||
int ast_unreal_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.fixup callback */
|
||||
int ast_unreal_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.send_html callback */
|
||||
int ast_unreal_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.send_text callback */
|
||||
int ast_unreal_sendtext(struct ast_channel *ast, const char *text);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.queryoption callback */
|
||||
int ast_unreal_queryoption(struct ast_channel *ast, int option, void *data, int *datalen);
|
||||
|
||||
/*! Unreal channel framework struct ast_channel_tech.setoption callback */
|
||||
int ast_unreal_setoption(struct ast_channel *chan, int option, void *data, int datalen);
|
||||
|
||||
/*!
|
||||
* \brief struct ast_unreal_pvt destructor.
|
||||
* \since 12.0.0
|
||||
*
|
||||
* \param vdoomed Object to destroy.
|
||||
*
|
||||
* \return Nothing
|
||||
*/
|
||||
void ast_unreal_destructor(void *vdoomed);
|
||||
|
||||
/*!
|
||||
* \brief Allocate the base unreal struct for a derivative.
|
||||
* \since 12.0.0
|
||||
*
|
||||
* \param size Size of the unreal struct to allocate.
|
||||
* \param destructor Destructor callback.
|
||||
* \param cap Format capabilities to give the unreal private struct.
|
||||
*
|
||||
* \retval pvt on success.
|
||||
* \retval NULL on error.
|
||||
*/
|
||||
struct ast_unreal_pvt *ast_unreal_alloc(size_t size, ao2_destructor_fn destructor, struct ast_format_cap *cap);
|
||||
|
||||
/*!
|
||||
* \brief Create the semi1 and semi2 unreal channels.
|
||||
* \since 12.0.0
|
||||
*
|
||||
* \param p Unreal channel private struct.
|
||||
* \param tech Channel technology to use.
|
||||
* \param semi1_state State to start the semi1(owner) channel in.
|
||||
* \param semi2_state State to start the semi2(outgoing chan) channel in.
|
||||
* \param exten Exten to start the chennels in. (NULL if s)
|
||||
* \param context Context to start the channels in. (NULL if default)
|
||||
* \param requestor Channel requesting creation. (NULL if none)
|
||||
* \param callid Thread callid to use.
|
||||
*
|
||||
* \retval semi1_channel on success.
|
||||
* \retval NULL on error.
|
||||
*/
|
||||
struct ast_channel *ast_unreal_new_channels(struct ast_unreal_pvt *p,
|
||||
const struct ast_channel_tech *tech, int semi1_state, int semi2_state,
|
||||
const char *exten, const char *context, const struct ast_channel *requestor,
|
||||
struct ast_callid *callid);
|
||||
|
||||
/*!
|
||||
* \brief Setup unreal owner and chan channels before initiating call.
|
||||
* \since 12.0.0
|
||||
*
|
||||
* \param semi1 Owner channel of unreal channel pair.
|
||||
* \param semi2 Outgoing channel of unreal channel pair.
|
||||
*
|
||||
* \note On entry, the semi1 and semi2 channels are already locked.
|
||||
*
|
||||
* \return Nothing
|
||||
*/
|
||||
void ast_unreal_call_setup(struct ast_channel *semi1, struct ast_channel *semi2);
|
||||
|
||||
/* ------------------------------------------------------------------- */
|
||||
|
||||
#if defined(__cplusplus) || defined(c_plusplus)
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* _ASTERISK_CORE_UNREAL_H */
|
||||
Reference in New Issue
Block a user