Files
asterisk/include/asterisk/stasis_system.h
Corey Farrell c701550803 Forward declare 'struct ast_json' in asterisk.h
The ast_json structure is used in many Asterisk headers and is often the
only part of json.h used.  This adds a forward declaration to asterisk.h
and removes the include of json.h from many headers.  The declaration
has been left in endpoints.h and stasis.h to avoid problems with source
files that use ast_json functions without directly including json.h.

ari.h continues to include json.h as it uses enum
ast_json_encoding_format.

Change-Id: Id766aabce6bed56626d27e8d29f559b5e687b769
2017-03-30 22:54:01 -05:00

137 lines
3.7 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013, Digium, Inc.
*
* Jason Parker <jparker@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_STASIS_SYSTEM_H
#define _ASTERISK_STASIS_SYSTEM_H
#include "asterisk/stasis.h"
/*!
* \since 12
* \brief Publish a channel driver outgoing registration message
*
* \param channeltype The channel driver that published the message
* \param username The username that was used to register
* \param domain The domain that was used to register
* \param status The result of the registration
* \param cause The reason for the result
*/
void ast_system_publish_registry(const char *channeltype, const char *username, const char *domain, const char *status, const char *cause);
/*!
* \since 12
* \brief A \ref stasis topic which publishes messages regarding system changes
*
* \retval \ref stasis_topic for system level changes
* \retval NULL on error
*/
struct stasis_topic *ast_system_topic(void);
/*!
* \since 12
* \brief A \ref stasis_message_type for network changes
*
* \retval NULL on error
* \retval \ref stasis_message_type for network changes
*
* \note Messages of this type should always be issued on and expected from
* the \ref ast_system_topic \ref stasis topic
*/
struct stasis_message_type *ast_network_change_type(void);
/*!
* \brief A \ref stasis_message_type for outbound registration.
* \since 12
*/
struct stasis_message_type *ast_system_registry_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Available messages.
* \since 12
*/
struct stasis_message_type *ast_cc_available_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Offer Timer Start messages.
* \since 12
*/
struct stasis_message_type *ast_cc_offertimerstart_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Requested messages.
* \since 12
*/
struct stasis_message_type *ast_cc_requested_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Request Acknowledged messages.
* \since 12
*/
struct stasis_message_type *ast_cc_requestacknowledged_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Caller Stop Monitoring messages.
* \since 12
*/
struct stasis_message_type *ast_cc_callerstopmonitoring_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Caller Start Monitoring messages.
* \since 12
*/
struct stasis_message_type *ast_cc_callerstartmonitoring_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Caller Recalling messages.
* \since 12
*/
struct stasis_message_type *ast_cc_callerrecalling_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Recall Complete messages.
* \since 12
*/
struct stasis_message_type *ast_cc_recallcomplete_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Failure messages.
* \since 12
*/
struct stasis_message_type *ast_cc_failure_type(void);
/*!
* \brief A \ref stasis_message_type for CCSS Monitor Failed messages.
* \since 12
*/
struct stasis_message_type *ast_cc_monitorfailed_type(void);
/*!
* \brief A \ref stasis_message_type for Cluster discovery
* \since 13.11.0
*/
struct stasis_message_type *ast_cluster_discovery_type(void);
/*!
* \brief Initialize the stasis system topic and message types
* \retval 0 on success
* \retval -1 on failure
*/
int ast_stasis_system_init(void);
#endif /* _ASTERISK_STASIS_SYSTEM_H */