Event source information and callbacks. More...
#include <stasis_app.h>
Data Fields | ||
| void *(* | find )(const struct stasis_app *app, const char *id) | |
| Find an event source data object by the given id/name. | ||
| int(* | is_subscribed )(struct stasis_app *app, const char *id) | |
| Find an event source by the given id/name. | ||
| struct { | ||
| struct stasis_app_event_source * next | ||
| } | next | |
| const char * | scheme | |
| The scheme to match against on [un]subscribes. | ||
| int(* | subscribe )(struct stasis_app *app, void *obj) | |
| Subscribe an application to an event source. | ||
| void(* | to_json )(const struct stasis_app *app, struct ast_json *json) | |
| Convert event source data to json. | ||
| int(* | unsubscribe )(struct stasis_app *app, const char *id) | |
| Cancel the subscription an app has to an event source. | ||
Detailed Description
Event source information and callbacks.
Definition at line 184 of file stasis_app.h.
Field Documentation
◆ find
| void *(* find) (const struct stasis_app *app, const char *id) |
Find an event source data object by the given id/name.
- Parameters
-
app Application id A unique identifier to search on
- Returns
- The data object associated with the id/name.
Definition at line 196 of file stasis_app.h.
Referenced by app_subscribe().
◆ is_subscribed
| int(* is_subscribed) (struct stasis_app *app, const char *id) |
Find an event source by the given id/name.
- Parameters
-
app Application id A unique identifier to check
- Returns
- true if id is subscribed, false otherwise.
Definition at line 226 of file stasis_app.h.
Referenced by app_unsubscribe(), and stasis_app_unregister().
◆ next [1/2]
| struct stasis_app_event_source* next |
Definition at line 237 of file stasis_app.h.
Referenced by __stasis_app_register(), app_event_source_find(), app_event_sources_to_json(), stasis_app_register_event_source(), stasis_app_unregister(), and stasis_app_unregister_event_source().
◆ [struct] [2/2]
| struct { ... } next |
Next item in the list
◆ scheme
| const char* scheme |
The scheme to match against on [un]subscribes.
Definition at line 186 of file stasis_app.h.
Referenced by app_event_source_find(), app_subscribe(), app_unsubscribe(), and stasis_app_unregister().
◆ subscribe
| int(* subscribe) (struct stasis_app *app, void *obj) |
Subscribe an application to an event source.
- Parameters
-
app Application obj an event source data object
- Returns
- 0 on success, failure code otherwise
Definition at line 206 of file stasis_app.h.
Referenced by __stasis_app_register(), and app_subscribe().
◆ to_json
| void(* to_json) (const struct stasis_app *app, struct ast_json *json) |
Convert event source data to json.
- Parameters
-
app Application id json object to fill
Definition at line 234 of file stasis_app.h.
Referenced by app_event_sources_to_json().
◆ unsubscribe
| int(* unsubscribe) (struct stasis_app *app, const char *id) |
Cancel the subscription an app has to an event source.
- Parameters
-
app Application id a previously subscribed object id
- Returns
- 0 on success, failure code otherwise
Definition at line 216 of file stasis_app.h.
Referenced by app_unsubscribe(), and stasis_app_unregister().
The documentation for this struct was generated from the following file:
