Fork me on GitHub
Data Structures | Macros | Typedefs | Functions | Variables
janus_websockets.c File Reference

Janus WebSockets transport plugin. More...

#include "transport.h"
#include <arpa/inet.h>
#include <net/if.h>
#include <ifaddrs.h>
#include <libwebsockets.h>
#include "../debug.h"
#include "../apierror.h"
#include "../config.h"
#include "../mutex.h"
#include "../utils.h"
Include dependency graph for janus_websockets.c:

Data Structures

struct  janus_websockets_client


#define JANUS_WEBSOCKETS_DESCRIPTION   "This transport plugin adds WebSockets support to the Janus API via libwebsockets."
#define JANUS_WEBSOCKETS_NAME   "JANUS WebSockets transport plugin"
#define JANUS_WEBSOCKETS_AUTHOR   "Meetecho s.r.l."
#define JANUS_WEBSOCKETS_PACKAGE   "janus.transport.websockets"
#define CASE_STR(name)   case name: return #name


typedef struct janus_websockets_client janus_websockets_client


janus_transportcreate (void)
int janus_websockets_init (janus_transport_callbacks *callback, const char *config_path)
void janus_websockets_destroy (void)
int janus_websockets_get_api_compatibility (void)
int janus_websockets_get_version (void)
const char * janus_websockets_get_version_string (void)
const char * janus_websockets_get_description (void)
const char * janus_websockets_get_name (void)
const char * janus_websockets_get_author (void)
const char * janus_websockets_get_package (void)
gboolean janus_websockets_is_janus_api_enabled (void)
gboolean janus_websockets_is_admin_api_enabled (void)
int janus_websockets_send_message (janus_transport_session *transport, void *request_id, gboolean admin, json_t *message)
void janus_websockets_session_created (janus_transport_session *transport, guint64 session_id)
void janus_websockets_session_over (janus_transport_session *transport, guint64 session_id, gboolean timeout, gboolean claimed)
void janus_websockets_session_claimed (janus_transport_session *transport, guint64 session_id)
void * janus_websockets_thread (void *data)


GList * janus_websockets_access_list = NULL
GList * janus_websockets_admin_access_list = NULL
janus_mutex access_list_mutex

Detailed Description

Janus WebSockets transport plugin.

Lorenzo Miniero

This is an implementation of a WebSockets transport for the Janus API, using the libwebsockets library ( This means that, with the help of this module, browsers or applications (e.g., nodejs server side implementations) can also make use of WebSockets to make requests to Janus. In that case, the same WebSocket can be used for both sending requests and receiving notifications, without the need for long polls. At the same time, without the concept of a REST path, requests sent through the WebSockets interface will need to include, when needed, additional pieces of information like session_id and handle_id. That is, where you'd send a Janus request related to a specific session to the /janus/ <session> path, with WebSockets you'd have to send the same request with an additional session_id field in the JSON payload. The same applies for the handle. The JavaScript library (janus.js) implements all of this on the client side automatically.

When you create a session using WebSockets, a subscription to the events related to it is done automatically, so no need for an explicit request as the GET in the plain HTTP API. Closing a WebSocket will also destroy all the sessions it created.


Macro Definition Documentation

#define CASE_STR (   name)    case name: return #name
#define JANUS_WEBSOCKETS_AUTHOR   "Meetecho s.r.l."
#define JANUS_WEBSOCKETS_DESCRIPTION   "This transport plugin adds WebSockets support to the Janus API via libwebsockets."
#define JANUS_WEBSOCKETS_NAME   "JANUS WebSockets transport plugin"
#define JANUS_WEBSOCKETS_PACKAGE   "janus.transport.websockets"

Typedef Documentation

Function Documentation

janus_transport* create ( void  )
void janus_websockets_destroy ( void  )
int janus_websockets_get_api_compatibility ( void  )
const char * janus_websockets_get_author ( void  )
const char * janus_websockets_get_description ( void  )
const char * janus_websockets_get_name ( void  )
const char * janus_websockets_get_package ( void  )
int janus_websockets_get_version ( void  )
const char * janus_websockets_get_version_string ( void  )
int janus_websockets_init ( janus_transport_callbacks callback,
const char *  config_path 
gboolean janus_websockets_is_admin_api_enabled ( void  )
gboolean janus_websockets_is_janus_api_enabled ( void  )
int janus_websockets_send_message ( janus_transport_session transport,
void *  request_id,
gboolean  admin,
json_t message 
void janus_websockets_session_claimed ( janus_transport_session transport,
guint64  session_id 
void janus_websockets_session_created ( janus_transport_session transport,
guint64  session_id 
void janus_websockets_session_over ( janus_transport_session transport,
guint64  session_id,
gboolean  timeout,
gboolean  claimed 
void * janus_websockets_thread ( void *  data)

Variable Documentation

janus_mutex access_list_mutex
GList* janus_websockets_access_list = NULL
GList * janus_websockets_admin_access_list = NULL