Fork me on GitHub
janus.h
Go to the documentation of this file.
1 
18 #ifndef JANUS_CORE_H
19 #define JANUS_CORE_H
20 
21 #include <inttypes.h>
22 #include <stdlib.h>
23 #include <stdint.h>
24 #include <stdio.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <unistd.h>
28 
29 #include <jansson.h>
30 
31 #include "mutex.h"
32 #include "ice.h"
33 #include "refcount.h"
34 #include "transports/transport.h"
35 #include "events/eventhandler.h"
36 #include "loggers/logger.h"
37 #include "plugins/plugin.h"
38 
39 
42 
44 typedef struct janus_session {
46  guint64 session_id;
48  GHashTable *ice_handles;
50  gint64 last_activity;
54  volatile gint timedout;
56  gint timeout;
58  volatile gint transport_gone;
62  volatile gint destroyed;
66 
67 
70 
74 janus_session *janus_session_create(guint64 session_id);
78 janus_session *janus_session_find(guint64 session_id);
82 void janus_session_notify_event(janus_session *session, json_t *event);
91 janus_ice_handle *janus_session_handles_find(janus_session *session, guint64 handle_id);
109 
110 
117 
125  void *request_id;
127  gboolean admin;
131  json_error_t *error;
133  volatile gint destroyed;
136 };
145 janus_request *janus_request_new(janus_transport *transport, janus_transport_session *instance, void *request_id, gboolean admin, json_t *message, json_error_t *error);
149 void janus_request_destroy(janus_request *request);
165 int janus_process_success(janus_request *request, json_t *payload);
176 int janus_process_error(janus_request *request, uint64_t session_id, const char *transaction, gint error, const char *format, ...) G_GNUC_PRINTF(5, 6);
178 
179 
189 
194 void janus_transport_close(void *key, void *value, void *user_data);
199 void janus_transportso_close(void *key, void *value, void *user_data);
201 
211 
216 void janus_eventhandler_close(void *key, void *value, void *user_data);
221 void janus_eventhandlerso_close(void *key, void *value, void *user_data);
223 
231 
236 void janus_logger_close(void *key, void *value, void *user_data);
241 void janus_loggerso_close(void *key, void *value, void *user_data);
243 
252 
257 void janus_plugin_close(void *key, void *value, void *user_data);
262 void janus_pluginso_close(void *key, void *value, void *user_data);
266 janus_plugin *janus_plugin_find(const gchar *package);
268 
270 gchar *janus_get_server_pem(void);
272 gchar *janus_get_server_key(void);
273 
274 
276 gchar *janus_get_local_ip(void);
278 gchar *janus_get_public_ip(guint index);
280 guint janus_get_public_ip_count(void);
282 void janus_add_public_ip(const char *ip);
284 gboolean janus_has_public_ipv4_ip(void);
286 gboolean janus_has_public_ipv6_ip(void);
287 
289 gint janus_is_stopping(void);
290 
299 
300 #endif
volatile gint timedout
Flag to notify there&#39;s been a session timeout.
Definition: janus.h:54
json_error_t * error
Pointer to any JSON errors parsing the original request.
Definition: janus.h:131
janus_request * janus_request_new(janus_transport *transport, janus_transport_session *instance, void *request_id, gboolean admin, json_t *message, json_error_t *error)
Helper to allocate a janus_request instance.
Definition: janus.c:933
gint janus_is_stopping(void)
Helper method to check whether the server is being shut down.
Definition: janus.c:258
janus_transport * transport
Pointer to the transport plugin.
Definition: janus.h:121
Janus handles and ICE/STUN/TURN processing (headers)
Reference counter mechanism.
Modular Janus API transports.
struct json_t json_t
Definition: plugin.h:236
int janus_process_success(janus_request *request, json_t *payload)
Method to return a successful Janus response message (JSON) to the browser.
Definition: janus.c:3137
janus_plugin * janus_plugin_find(const gchar *package)
Method to return a registered plugin instance out of its package name.
Definition: janus.c:3651
void janus_request_destroy(janus_request *request)
Helper to destroy a janus_request instance.
Definition: janus.c:952
int janus_process_incoming_request(janus_request *request)
Helper to process an incoming request, no matter where it comes from.
Definition: janus.c:1049
gint64 last_activity
Time of the last activity on the session.
Definition: janus.h:50
gboolean janus_has_public_ipv4_ip(void)
Helper method to check if we have at least one manually passed public IPv4 address (for 1-1 NAT manag...
Definition: janus.c:249
int janus_process_error(janus_request *request, uint64_t session_id, const char *transaction, gint error, const char *format,...) G_GNUC_PRINTF(5
Method to return an error Janus response message (JSON) to the browser.
void janus_loggerso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to close a logger plugin.
GMutex janus_mutex
Janus mutex implementation.
Definition: mutex.h:73
janus_session * janus_session_find(guint64 session_id)
Method to find an existing Janus Core-Client session from its ID.
Definition: janus.c:799
Plugin-Core communication (implementation)
void janus_logger_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to destroy a logger instance.
void janus_pluginso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to close a plugin.
gboolean janus_has_public_ipv6_ip(void)
Helper method to check if we have at least one manually passed public IPv6 address (for 1-1 NAT manag...
Definition: janus.c:252
Definition: refcount.h:78
Helper to address requests and their sources (e.g., a specific HTTP connection, websocket, RabbitMQ or others)
Definition: janus.h:119
janus_mutex mutex
Mutex to lock/unlock this session.
Definition: janus.h:60
gchar * janus_get_public_ip(guint index)
Helper method to return a given public IP address to use in the SDP (if multiple are configured for 1...
Definition: janus.c:220
guint janus_get_public_ip_count(void)
Helper method to return the number of public IP addresses (if configured for 1-1 NAT) ...
Definition: janus.c:217
Janus Core-Client session.
Definition: janus.h:44
void janus_session_handles_clear(janus_session *session)
Method to remove all Janus ICE handles from a session.
Definition: janus.c:876
void janus_add_public_ip(const char *ip)
Helper method to add an IP address to use in the SDP.
gint timeout
Timeout value in seconds to use with this session, 0 is unlimited, -1 is global session timeout setti...
Definition: janus.h:56
janus_transport_session * instance
Pointer to the transport-provided session instance.
Definition: janus.h:123
void janus_plugin_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to destroy a plugin instance.
void janus_transportso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to close a transport plugin.
janus_session * janus_session_create(guint64 session_id)
Method to create a new Janus Core-Client session.
Definition: janus.c:767
void janus_eventhandlerso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to close an eventhandler plugin.
janus_request * source
Pointer to the request instance (and the transport that originated the session)
Definition: janus.h:52
The plugin session and callbacks interface.
Definition: plugin.h:252
gboolean janus_is_webrtc_encryption_enabled(void)
Helper method to check whether WebRTC encryption is (as it should) enabled.
Definition: janus.c:320
GHashTable * ice_handles
Map of handles this session is managing.
Definition: janus.h:48
json_t * message
Pointer to the original request, if available.
Definition: janus.h:129
void janus_transport_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to destroy a transport instance.
volatile gint transport_gone
Flag to notify that transport is gone.
Definition: janus.h:58
gchar * janus_get_server_key(void)
Helper method to return the path to the provided server certificate key.
janus_refcount ref
Reference counter for this instance.
Definition: janus.h:64
gint janus_session_handles_remove(janus_session *session, janus_ice_handle *handle)
Method to remove a Janus ICE handle from a session.
Definition: janus.c:867
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: janus.h:62
Modular Janus event handlers (headers)
Janus ICE handle.
Definition: ice.h:354
void janus_eventhandler_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it&#39;s time to destroy an eventhandler instance...
The transport plugin session and callbacks interface.
Definition: transport.h:175
json_t * janus_session_handles_list_json(janus_session *session)
Method to list the IDs of all Janus ICE handles of a session as JSON.
Definition: janus.c:895
void janus_session_handles_insert(janus_session *session, janus_ice_handle *handle)
Method to insert a Janus ICE handle in a session.
Definition: janus.c:857
Semaphores, Mutexes and Conditions.
janus_refcount ref
Reference counter for this instance.
Definition: janus.h:135
gchar * janus_get_server_pem(void)
Helper method to return the path to the provided server certificate.
void janus_session_notify_event(janus_session *session, json_t *event)
Method to add an event to notify to the queue of notifications for this session.
Definition: janus.c:811
Transport-Gateway session mapping.
Definition: transport.h:145
janus_ice_handle * janus_session_handles_find(janus_session *session, guint64 handle_id)
Method to find an existing Janus ICE handle from its ID.
Definition: janus.c:843
Modular Janus loggers (headers)
gint janus_session_destroy(janus_session *session)
Method to destroy a Janus Core-Client session.
Definition: janus.c:831
guint64 session_id
Janus Core-Client session ID.
Definition: janus.h:46
void * request_id
Opaque pointer to the request ID, if available.
Definition: janus.h:125
gchar * janus_get_local_ip(void)
Helper method to return the local IP address (autodetected by default)
Definition: janus.c:211
gboolean admin
Whether this is a Janus API or admin API request.
Definition: janus.h:127
struct janus_session janus_session
Janus Core-Client session.
int janus_process_incoming_admin_request(janus_request *request)
Helper to process an incoming admin/monitor request, no matter where it comes from.
Definition: janus.c:2120
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: janus.h:133