Fork me on GitHub
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
eventhandler.h
Go to the documentation of this file.
1 
86 #ifndef JANUS_EVENTHANDLER_H
87 #define JANUS_EVENTHANDLER_H
88 
89 #include <stdlib.h>
90 #include <stdint.h>
91 #include <stdio.h>
92 #include <string.h>
93 #include <ctype.h>
94 #include <unistd.h>
95 #include <inttypes.h>
96 
97 #include <glib.h>
98 #include <jansson.h>
99 
100 #include "../utils.h"
101 
102 
104 #define JANUS_EVENTHANDLER_API_VERSION 3
105 
127 
129 #define JANUS_EVENT_TYPE_NONE (0)
130 
131 #define JANUS_EVENT_TYPE_SESSION (1 << 0)
132 
133 #define JANUS_EVENT_TYPE_HANDLE (1 << 1)
134 
135 #define JANUS_EVENT_TYPE_EXTERNAL (1 << 2)
136 
137 #define JANUS_EVENT_TYPE_JSEP (1 << 3)
138 
139 #define JANUS_EVENT_TYPE_WEBRTC (1 << 4)
140 
141 #define JANUS_EVENT_TYPE_MEDIA (1 << 5)
142 
143 #define JANUS_EVENT_TYPE_PLUGIN (1 << 6)
144 
145 #define JANUS_EVENT_TYPE_TRANSPORT (1 << 7)
146 
147 #define JANUS_EVENT_TYPE_CORE (1 << 8)
148  /* TODO Others? */
150 #define JANUS_EVENT_TYPE_ALL (0xffffffff)
151 
153 #define JANUS_EVENTHANDLER_INIT(...) { \
154  .init = NULL, \
155  .destroy = NULL, \
156  .get_api_compatibility = NULL, \
157  .get_version = NULL, \
158  .get_version_string = NULL, \
159  .get_description = NULL, \
160  .get_name = NULL, \
161  .get_author = NULL, \
162  .get_package = NULL, \
163  .incoming_event = NULL, \
164  .events_mask = JANUS_EVENT_TYPE_NONE, \
165  ## __VA_ARGS__ }
166 
167 
170 
171 
177  int (* const init)(const char *config_path);
179  void (* const destroy)(void);
180 
184  int (* const get_api_compatibility)(void);
186  int (* const get_version)(void);
188  const char *(* const get_version_string)(void);
190  const char *(* const get_description)(void);
192  const char *(* const get_name)(void);
194  const char *(* const get_author)(void);
196  const char *(* const get_package)(void);
197 
217  void (* const incoming_event)(json_t *event);
218 
230  json_t *(* const handle_request)(json_t *request);
231 
234 };
235 
238 
239 #endif
int(*const get_api_compatibility)(void)
Informative method to request the API version this event handler plugin was compiled against...
Definition: eventhandler.h:184
gsize janus_flags
Janus flags container.
Definition: utils.h:86
struct json_t json_t
Definition: plugin.h:225
janus_flags events_mask
Mask of events this handler is interested in, as a janus_flags object.
Definition: eventhandler.h:233
int(*const get_version)(void)
Informative method to request the numeric version of the event handler plugin.
Definition: eventhandler.h:186
int(*const init)(const char *config_path)
Event handler plugin initialization/constructor.
Definition: eventhandler.h:177
const char *(*const get_author)(void)
Informative method to request the author of the event handler plugin.
Definition: eventhandler.h:194
The event handler plugin session and callbacks interface.
Definition: eventhandler.h:173
json_t *(*const handle_request)(json_t *request)
Method to send a request to this specific event handler plugin.
Definition: eventhandler.h:230
void(*const incoming_event)(json_t *event)
Method to notify the event handler plugin that a new event is available.
Definition: eventhandler.h:217
const char *(*const get_package)(void)
Informative method to request the package name of the event handler plugin (what will be used in web ...
Definition: eventhandler.h:196
const char *(*const get_version_string)(void)
Informative method to request the string version of the event handler plugin.
Definition: eventhandler.h:188
const char *(*const get_name)(void)
Informative method to request the name of the event handler plugin.
Definition: eventhandler.h:192
void(*const destroy)(void)
Event handler plugin deinitialization/destructor.
Definition: eventhandler.h:179
const char *(*const get_description)(void)
Informative method to request a description of the event handler plugin.
Definition: eventhandler.h:190
janus_eventhandler * create_e(void)
The hook that event handler plugins need to implement to be created from the Janus core...
Definition: eventhandler.h:237