[asterisk-commits] dlee: branch dlee/stasis-app r382373 - /team/dlee/stasis-app/include/asterisk/

[SVN commits to the Asterisk project]

Author: dlee
Date: Mon Mar  4 10:22:12 2013
New Revision: 382373

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=382373
Log:
Comments

Modified:
    team/dlee/stasis-app/include/asterisk/app_stasis.h

Modified: team/dlee/stasis-app/include/asterisk/app_stasis.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/stasis-app/include/asterisk/app_stasis.h?view=diff&rev=382373&r1=382372&r2=382373
==============================================================================
--- team/dlee/stasis-app/include/asterisk/app_stasis.h (original)
+++ team/dlee/stasis-app/include/asterisk/app_stasis.h Mon Mar  4 10:22:12 2013
@@ -21,34 +21,35 @@
 
 /*! \file
  *
- * \brief Stasis Application API.
+ * \brief Stasis Application API. See \ref app_stasis "Stasis Application API"
+ * for detailed documentation.
+ *
+ * \author David M. Lee, II <dlee at digium.com>
+ * \since 12
+ *
+ * \page app_stasis Stasis Application API
  *
  * This is the API that binds the Stasis dialplan application to external
- * Stasis applications.
+ * Stasis applications, such as \c res_stasis_websocket.
  *
- * \author David M. Lee, II <dlee at digium.com>
+ * 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"
 
 /*! @{ */
-
-/*! \brief Handler for a registered Stasis applicatoin. */
-struct stasis_app;
-
-/*!
- * \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 ast_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 Callback for Stasis application handler.
@@ -79,6 +80,19 @@
  * \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 ast_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);
 
 /*! @} */