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 
40 #define JANUS_BUFSIZE 8192
41 
43 typedef struct janus_request janus_request;
44 
46 typedef struct janus_session {
48  guint64 session_id;
50  GHashTable *ice_handles;
52  gint64 last_activity;
56  volatile gint timedout;
58  gint timeout;
60  volatile gint transport_gone;
64  volatile gint destroyed;
68 
69 
72 
76 janus_session *janus_session_create(guint64 session_id);
80 janus_session *janus_session_find(guint64 session_id);
84 void janus_session_notify_event(janus_session *session, json_t *event);
93 janus_ice_handle *janus_session_handles_find(janus_session *session, guint64 handle_id);
111 
112 
119 
127  void *request_id;
129  gboolean admin;
133  volatile gint destroyed;
136 };
144 janus_request *janus_request_new(janus_transport *transport, janus_transport_session *instance, void *request_id, gboolean admin, json_t *message);
148 void janus_request_destroy(janus_request *request);
164 int janus_process_success(janus_request *request, json_t *payload);
175 int janus_process_error(janus_request *request, uint64_t session_id, const char *transaction, gint error, const char *format, ...) G_GNUC_PRINTF(5, 6);
177 
178 
188 
193 void janus_transport_close(void *key, void *value, void *user_data);
198 void janus_transportso_close(void *key, void *value, void *user_data);
200 
210 
215 void janus_eventhandler_close(void *key, void *value, void *user_data);
220 void janus_eventhandlerso_close(void *key, void *value, void *user_data);
222 
230 
235 void janus_logger_close(void *key, void *value, void *user_data);
240 void janus_loggerso_close(void *key, void *value, void *user_data);
242 
251 
256 void janus_plugin_close(void *key, void *value, void *user_data);
261 void janus_pluginso_close(void *key, void *value, void *user_data);
265 janus_plugin *janus_plugin_find(const gchar *package);
267 
269 gchar *janus_get_server_pem(void);
271 gchar *janus_get_server_key(void);
272 
273 
275 gchar *janus_get_local_ip(void);
277 gchar *janus_get_public_ip(guint index);
279 guint janus_get_public_ip_count(void);
281 void janus_add_public_ip(const char *ip);
283 gboolean janus_has_public_ipv4_ip(void);
285 gboolean janus_has_public_ipv6_ip(void);
286 
288 gint janus_is_stopping(void);
289 
298 
299 #endif
janus_session::timeout
gint timeout
Timeout value in seconds to use with this session, 0 is unlimited, -1 is global session timeout setti...
Definition: janus.h:58
janus_get_public_ip
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:211
ice.h
Janus handles and ICE/STUN/TURN processing (headers)
janus_session_destroy
gint janus_session_destroy(janus_session *session)
Method to destroy a Janus Core-Client session.
Definition: janus.c:795
janus_process_error
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.
janus_request::transport
janus_transport * transport
Pointer to the transport plugin.
Definition: janus.h:123
janus_plugin
The plugin session and callbacks interface.
Definition: plugin.h:252
janus_session::source
janus_request * source
Pointer to the request instance (and the transport that originated the session)
Definition: janus.h:54
janus_request::admin
gboolean admin
Whether this is a Janus API or admin API request.
Definition: janus.h:129
janus_transportso_close
void janus_transportso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to close a transport plugin.
janus_get_server_key
gchar * janus_get_server_key(void)
Helper method to return the path to the provided server certificate key.
janus_add_public_ip
void janus_add_public_ip(const char *ip)
Helper method to add an IP address to use in the SDP.
janus_is_webrtc_encryption_enabled
gboolean janus_is_webrtc_encryption_enabled(void)
Helper method to check whether WebRTC encryption is (as it should) enabled.
Definition: janus.c:308
logger.h
Modular Janus loggers (headers)
janus_transport_close
void janus_transport_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to destroy a transport instance.
janus_eventhandler_close
void janus_eventhandler_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to destroy an eventhandler instance.
janus_has_public_ipv6_ip
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:243
janus_transport_session
Transport-Gateway session mapping.
Definition: transport.h:145
janus_request::message
json_t * message
Pointer to the original request, if available.
Definition: janus.h:131
plugin.h
Plugin-Core communication (implementation)
janus_session::transport_gone
volatile gint transport_gone
Flag to notify that transport is gone.
Definition: janus.h:60
janus_session::mutex
janus_mutex mutex
Mutex to lock/unlock this session.
Definition: janus.h:62
janus_session::timedout
volatile gint timedout
Flag to notify there's been a session timeout.
Definition: janus.h:56
janus_session_handles_find
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:807
janus_loggerso_close
void janus_loggerso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to close a logger plugin.
janus_transport
The transport plugin session and callbacks interface.
Definition: transport.h:175
janus_request_new
janus_request * janus_request_new(janus_transport *transport, janus_transport_session *instance, void *request_id, gboolean admin, json_t *message)
Helper to allocate a janus_request instance.
Definition: janus.c:889
janus_session::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: janus.h:64
janus_session_find
janus_session * janus_session_find(guint64 session_id)
Method to find an existing Janus Core-Client session from its ID.
Definition: janus.c:763
eventhandler.h
Modular Janus event handlers (headers)
janus_session_handles_list_json
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:856
janus_request
Helper to address requests and their sources (e.g., a specific HTTP connection, websocket,...
Definition: janus.h:121
janus_refcount
Definition: refcount.h:78
janus_process_success
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:2931
janus_ice_handle
Janus ICE handle.
Definition: ice.h:314
janus_session
Janus Core-Client session.
Definition: janus.h:46
janus_get_server_pem
gchar * janus_get_server_pem(void)
Helper method to return the path to the provided server certificate.
janus_logger_close
void janus_logger_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to destroy a logger instance.
janus_session::session_id
guint64 session_id
Janus Core-Client session ID.
Definition: janus.h:48
janus_session_notify_event
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:775
janus_has_public_ipv4_ip
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:240
janus_session_handles_clear
void janus_session_handles_clear(janus_session *session)
Method to remove all Janus ICE handles from a session.
Definition: janus.c:838
janus_session::ref
janus_refcount ref
Reference counter for this instance.
Definition: janus.h:66
janus_request::ref
janus_refcount ref
Reference counter for this instance.
Definition: janus.h:135
json_t
struct json_t json_t
Definition: plugin.h:236
janus_get_public_ip_count
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:208
janus_session::ice_handles
GHashTable * ice_handles
Map of handles this session is managing.
Definition: janus.h:50
janus_request_destroy
void janus_request_destroy(janus_request *request)
Helper to destroy a janus_request instance.
Definition: janus.c:902
janus_pluginso_close
void janus_pluginso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to close a plugin.
janus_request::request_id
void * request_id
Opaque pointer to the request ID, if available.
Definition: janus.h:127
mutex.h
Semaphors, Mutexes and Conditions.
janus_plugin_close
void janus_plugin_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to destroy a plugin instance.
janus_is_stopping
gint janus_is_stopping(void)
Helper method to check whether the server is being shut down.
Definition: janus.c:249
janus_eventhandlerso_close
void janus_eventhandlerso_close(void *key, void *value, void *user_data)
Callback (g_hash_table_foreach) invoked when it's time to close an eventhandler plugin.
janus_get_local_ip
gchar * janus_get_local_ip(void)
Helper method to return the local IP address (autodetected by default)
Definition: janus.c:202
janus_session::last_activity
gint64 last_activity
Time of the last activity on the session.
Definition: janus.h:52
transport.h
Modular Janus API transports.
refcount.h
Reference counter mechanism.
janus_session_create
janus_session * janus_session_create(guint64 session_id)
Method to create a new Janus Core-Client session.
Definition: janus.c:732
janus_process_incoming_admin_request
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:1927
janus_plugin_find
janus_plugin * janus_plugin_find(const gchar *package)
Method to return a registered plugin instance out of its package name.
Definition: janus.c:3421
janus_session_handles_insert
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:821
janus_process_incoming_request
int janus_process_incoming_request(janus_request *request)
Helper to process an incoming request, no matter where it comes from.
Definition: janus.c:999
janus_mutex
GMutex janus_mutex
Janus mutex implementation.
Definition: mutex.h:61
janus_request::instance
janus_transport_session * instance
Pointer to the transport-provided session instance.
Definition: janus.h:125
janus_request::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: janus.h:133
janus_session
struct janus_session janus_session
Janus Core-Client session.
janus_session_handles_remove
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:830