Skip to content

Commit

Permalink
Replaced old and confusing 'gateway' label pretty much everwhere
Browse files Browse the repository at this point in the history
  • Loading branch information
lminiero committed Sep 6, 2018
1 parent 24e6f4d commit f88f34f
Show file tree
Hide file tree
Showing 83 changed files with 362 additions and 366 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ following steps:
* *Note:* you may need to pass `--libdir=/usr/lib64` to the configure
script if you're installing on a x86_64 distribution.

To conclude, should you be interested in building the gateway
To conclude, should you be interested in building the Janus
documentation as well, you'll need some additional tools too:

* [Doxygen](http://www.doxygen.org)
Expand Down Expand Up @@ -316,7 +316,7 @@ when configuring Janus as well, e.g.:
Everything else works exactly the same way as on Linux.

## Configure and start
To start the gateway, you can use the janus executable. There are several
To start the server, you can use the `janus` executable. There are several
things you can configure, either in a configuration file:

<installdir>/etc/janus/janus.cfg
Expand Down Expand Up @@ -345,7 +345,7 @@ or on the command line:
-k, --cert-key=filename DTLS certificate key
-K, --cert-pwd=text DTLS certificate key passphrase (if needed)
-S, --stun-server=filename STUN server(:port) to use, if needed (e.g.,
gateway behind NAT, default=none)
Janus behind NAT, default=none)
-1, --nat-1-1=ip Public IP to put in all host candidates,
assuming a 1:1 NAT is in place (e.g., Amazon
EC2 instances, default=none)
Expand Down Expand Up @@ -399,11 +399,11 @@ or on the command line:
-e, --event-handlers Enable event handlers (default=off)

Options passed through the command line have the precedence on those
specified in the configuration file. To start the gateway, simply run:
specified in the configuration file. To start the server, simply run:

<installdir>/bin/janus

This will start the gateway, and have it look at the configuration file.
This will start the server, and have it look at the configuration file.

Make sure you have a look at all of the configuration files, to tailor
Janus to your specific needs: each configuration file is documented, so
Expand Down
5 changes: 2 additions & 3 deletions apierror.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
#define JANUS_ERROR_TRANSPORT_SPECIFIC 450
/*! \brief The request is missing in the message */
#define JANUS_ERROR_MISSING_REQUEST 452
/*! \brief The gateway does not suppurt this request */
/*! \brief The Janus core does not suppurt this request */
#define JANUS_ERROR_UNKNOWN_REQUEST 453
/*! \brief The payload is not a valid JSON message */
#define JANUS_ERROR_INVALID_JSON 454
Expand All @@ -48,8 +48,7 @@
#define JANUS_ERROR_PLUGIN_MESSAGE 462
/*! \brief An error occurring when trying to detach from a plugin and destroy the related handle */
#define JANUS_ERROR_PLUGIN_DETACH 463
/*! \brief The gateway doesn't support this SDP type
* \todo The gateway currently only supports OFFER and ANSWER. */
/*! \brief The Janus core doesn't support this SDP type */
#define JANUS_ERROR_JSEP_UNKNOWN_TYPE 464
/*! \brief The Session Description provided by the peer is invalid */
#define JANUS_ERROR_JSEP_INVALID_SDP 465
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"Damon Oehlman <[email protected]>",
"Scott <[email protected]>"
],
"description": "A javascript library for interacting with the C based Janus WebRTC Gateway",
"description": "A javascript library for interacting with the C based Janus WebRTC Server",
"main": "./html/janus.js",
"license": "GPLv3",
"ignore": [
Expand Down
2 changes: 1 addition & 1 deletion configure.ac
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
AC_INIT([Janus Gateway],[0.4.4],[https://github.com/meetecho/janus-gateway],[janus-gateway],[https://janus.conf.meetecho.com])
AC_INIT([Janus WebRTC Server],[0.4.4],[https://github.com/meetecho/janus-gateway],[janus-gateway],[https://janus.conf.meetecho.com])
AC_CONFIG_AUX_DIR([.])
AC_CONFIG_MACRO_DIR([m4])

Expand Down
2 changes: 1 addition & 1 deletion debug.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ static const char *janus_log_prefix[] = {
/*! \brief Simple wrapper to g_print/printf */
#define JANUS_PRINT janus_vprintf
/*! \brief Logger based on different levels, which can either be displayed
* or not according to the configuration of the gateway.
* or not according to the configuration of the server.
* The format must be a string literal. */
#define JANUS_LOG(level, format, ...) \
do { \
Expand Down
4 changes: 2 additions & 2 deletions docs/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<ul>
$navpath
<li class="footer">
Janus WebRTC Gateway &copy; <a target="_blank" href="http://www.meetecho.com/">Meetecho</a> 2014-2018
Janus WebRTC Server &copy; <a target="_blank" href="http://www.meetecho.com/">Meetecho</a> 2014-2018
</li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<div class="footer container">
<hr class="footer"/>
Last updated on $date &mdash; Janus WebRTC Gateway &copy; <a target="_blank" href="http://www.meetecho.com/">Meetecho</a> 2014-2018
Last updated on $date &mdash; Janus WebRTC Server &copy; <a target="_blank" href="http://www.meetecho.com/">Meetecho</a> 2014-2018
</div>
<!--END !GENERATE_TREEVIEW-->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/janus-doxygen.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NUMBER = 0.4.4
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "Janus WebRTC Gateway"
PROJECT_BRIEF = "Janus WebRTC Server"

# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
Expand Down
2 changes: 1 addition & 1 deletion dtls.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* \brief DTLS/SRTP processing
* \details Implementation (based on OpenSSL and libsrtp) of the DTLS/SRTP
* transport. The code takes care of the DTLS handshake between peers and
* the gateway, and sets the proper SRTP and SRTCP context up accordingly.
* the server, and sets the proper SRTP and SRTCP context up accordingly.
* A DTLS alert from a peer is notified to the plugin handling him/her
* by means of the hangup_media callback.
*
Expand Down
4 changes: 2 additions & 2 deletions dtls.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* \brief DTLS/SRTP processing (headers)
* \details Implementation (based on OpenSSL and libsrtp) of the DTLS/SRTP
* transport. The code takes care of the DTLS handshake between peers and
* the gateway, and sets the proper SRTP and SRTCP context up accordingly.
* the server, and sets the proper SRTP and SRTCP context up accordingly.
* A DTLS alert from a peer is notified to the plugin handling him/her
* by means of the hangup_media callback.
*
Expand Down Expand Up @@ -55,7 +55,7 @@ typedef enum janus_dtls_state {
typedef struct janus_dtls_srtp {
/*! \brief Opaque pointer to the component this DTLS-SRTP context belongs to */
void *component;
/*! \brief DTLS role of the gateway for this stream: 1=client, 0=server */
/*! \brief DTLS role of the server for this stream: 1=client, 0=server */
janus_dtls_role dtls_role;
/*! \brief DTLS state of this component: -1=failed, 0=nothing, 1=trying, 2=connected */
janus_dtls_state dtls_state;
Expand Down
18 changes: 9 additions & 9 deletions events/eventhandler.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
* Whatever the aim, the structures to make the interaction between core
* and event handlers possible are defined here.
*
* An event handler plugin that wants to register at the gateway needs to
* An event handler plugin that wants to register at the Janus core needs to
* implement the \c janus_eventhandler interface. This includes callbacks
* the Janus core can use to pass and request information, and a mask of
* the events the plugin is interested in subscribing to. Besides, as an
* event handler plugin is a shared object, and as such external to the
* gateway itself, in order to be dynamically loaded at startup it needs
* core itself, in order to be dynamically loaded at startup it needs
* to implement the \c create_e() hook as well, that should return a
* pointer to the plugin instance. This is an example of such a step:
*
Expand All @@ -38,16 +38,16 @@ janus_eventhandler *create(void) {
\endverbatim
*
* This will make sure that your event handler plugin is loaded at startup
* by the gateway, if it is deployed in the proper folder.
* by the Janus core, if it is deployed in the proper folder.
*
* As anticipated and described in the above example, an event handler plugin
* must basically be an instance of the \c janus_eventhandler type. As such,
* it must implement the following methods and callbacks for the gateway:
* it must implement the following methods and callbacks for the core:
*
* - \c init(): this is called by the gateway as soon as your event handler
* - \c init(): this is called by the Janus core as soon as your event handler
* plugin is started; this is where you should setup your event handler plugin
* (e.g., static stuff and reading the configuration file);
* - \c destroy(): on the other hand, this is called by the gateway when it
* - \c destroy(): on the other hand, this is called by the core when it
* is shutting down, and your event handler plugin should too;
* - \c get_api_compatibility(): this method MUST return JANUS_EVENTHANDLER_API_VERSION;
* - \c get_version(): this method should return a numeric version identifier (e.g., 3);
Expand All @@ -69,13 +69,13 @@ janus_eventhandler *create(void) {
*
* Unlike other kind of modules (transports, plugins), the \c init() method
* here only passes the path to the configurations files folder, as event
* handlers never need to contact the gateway themselves. This path can be used to read and
* handlers never need to contact the Janus core themselves. This path can be used to read and
* parse a configuration file for the event handler plugin: the event handler
* plugins we made available out of the box use the package name as a
* name for the file (e.g., \c janus.eventhandler.fake.cfg for the sample
* event handler plugin), but you're free to use a different one, as long
* as it doesn't collide with existing ones. Besides, the existing eventhandler
* plugins use the same INI format for configuration files the gateway
* plugins use the same INI format for configuration files the core
* uses (relying on the \c janus_config helpers for the purpose) but
* again, if you prefer a different format (XML, JSON, etc.) that's up to you.
*
Expand Down Expand Up @@ -233,7 +233,7 @@ struct janus_eventhandler {
janus_flags events_mask;
};

/*! \brief The hook that event handler plugins need to implement to be created from the gateway */
/*! \brief The hook that event handler plugins need to implement to be created from the Janus core */
typedef janus_eventhandler* create_e(void);

#endif
4 changes: 2 additions & 2 deletions html/admin.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Admin/Monitor</title>
<title>Janus WebRTC Server: Admin/Monitor</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.2/js/bootstrap.min.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/bootbox.js/4.1.0/bootbox.min.js"></script>
Expand Down Expand Up @@ -33,7 +33,7 @@
<div class="row">
<div class="col-md-12">
<div class="page-header">
<h1>Janus WebRTC Gateway: Admin/Monitor</h1>
<h1>Janus WebRTC Server: Admin/Monitor</h1>
</div>

<div>
Expand Down
2 changes: 1 addition & 1 deletion html/audiobridgetest.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Audio Bridge Demo</title>
<title>Janus WebRTC Server: Audio Bridge Demo</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/webrtc-adapter/6.0.3/adapter.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery.blockUI/2.70/jquery.blockUI.min.js" ></script>
Expand Down
4 changes: 2 additions & 2 deletions html/audiobridgetest.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
// var server = "ws://" + window.location.hostname + ":8188";
//
// Of course this assumes that support for WebSockets has been built in
// when compiling the gateway. WebSockets support has not been tested
// when compiling the server. WebSockets support has not been tested
// as much as the REST API, so handle with care!
//
//
// If you have multiple options available, and want to let the library
// autodetect the best way to contact your gateway (or pool of gateways),
// autodetect the best way to contact your server (or pool of servers),
// you can also pass an array of servers, e.g., to provide alternative
// means of access (e.g., try WebSockets first and, if that fails, fall
// back to plain HTTP) or just have failover servers:
Expand Down
2 changes: 1 addition & 1 deletion html/citeus.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Cite us!</title>
<title>Janus WebRTC Server: Cite us!</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.2/js/bootstrap.min.js"></script>
<script>
Expand Down
6 changes: 3 additions & 3 deletions html/demos.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Demo Tests</title>
<title>Janus WebRTC Server: Demo Tests</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.2/js/bootstrap.min.js"></script>
<script>
Expand All @@ -30,7 +30,7 @@
<div class="row">
<div class="col-md-12">
<div class="page-header">
<h1>Janus WebRTC Gateway: Demo Tests</h1>
<h1>Janus WebRTC Server: Demo Tests</h1>
</div>
<table class="table table-striped">
<tr>
Expand All @@ -46,7 +46,7 @@ <h1>Janus WebRTC Gateway: Demo Tests</h1>
</tr>
<tr>
<td><a href="videocalltest.html">Video Call</a></td>
<td>A Video Call demo, a bit like AppRTC but with media passing through the gateway.</td>
<td>A Video Call demo, a bit like AppRTC but with media passing through Janus.</td>
</tr>
<tr>
<td><a href="siptest.html">SIP Gateway (Sofia)</a></td>
Expand Down
2 changes: 1 addition & 1 deletion html/devicetest.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Echo Test</title>
<title>Janus WebRTC Server: Echo Test</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/webrtc-adapter/6.0.3/adapter.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery.blockUI/2.70/jquery.blockUI.min.js" ></script>
Expand Down
4 changes: 2 additions & 2 deletions html/devicetest.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
// var server = "ws://" + window.location.hostname + ":8188";
//
// Of course this assumes that support for WebSockets has been built in
// when compiling the gateway. WebSockets support has not been tested
// when compiling the server. WebSockets support has not been tested
// as much as the REST API, so handle with care!
//
//
// If you have multiple options available, and want to let the library
// autodetect the best way to contact your gateway (or pool of gateways),
// autodetect the best way to contact your server (or pool of servers),
// you can also pass an array of servers, e.g., to provide alternative
// means of access (e.g., try WebSockets first and, if that fails, fall
// back to plain HTTP) or just have failover servers:
Expand Down
6 changes: 3 additions & 3 deletions html/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Documentation</title>
<title>Janus WebRTC Server: Documentation</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.2/js/bootstrap.min.js"></script>
<script>
Expand All @@ -31,8 +31,8 @@
<div class="page-header">
<h1>Documentation</h1>
</div>
<h3>Janus WebRTC Gateway: Documentation</h3>
<p>You can build a documentation for the gateway adding:</p>
<h3>Janus WebRTC Server: Documentation</h3>
<p>You can build a documentation for the server adding:</p>
<div class="alert alert-info">--enable-docs</div>
<p>to the configure options. You'll need <a href="http://www.doxygen.org">Doxygen</a> and <a href="http://www.graphviz.org/">Graphviz</a> installed.</p>
</div>
Expand Down
8 changes: 4 additions & 4 deletions html/echotest.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Janus WebRTC Gateway: Echo Test</title>
<title>Janus WebRTC Server: Echo Test</title>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/webrtc-adapter/6.0.3/adapter.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.7.2/jquery.min.js" ></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery.blockUI/2.70/jquery.blockUI.min.js" ></script>
Expand Down Expand Up @@ -49,13 +49,13 @@ <h1>Plugin Demo: Echo Test
<h3>Demo details</h3>
<p>This Echo Test demo just blindly sends you back whatever you
send to it. You're basically attached to yourself, and so your audio
and video you send to the gateway are echoed back to you. The same
and video you send to Janus are echoed back to you. The same
is done for RTCP packets as well, with the information properly updated.</p>
<p>The demo also provides a few controls to manipulate the media
before you send them. You can mute audio and video, for instance,
which will tell the gateway to drop the frames and not echo them
which will tell the server to drop the frames and not echo them
back to you. You can also try and cap the bitrate: such control
will tell the gateway to manipulate the RTCP REMB packets passing
will tell the server to manipulate the RTCP REMB packets passing
through, in order to simulate a bandwidth limitation. In case
you're interested in testing simulcasting, add the <code>?simulcast=true</code>
query string to the url of this page and reload it: buttons will appear
Expand Down
4 changes: 2 additions & 2 deletions html/echotest.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
// var server = "ws://" + window.location.hostname + ":8188";
//
// Of course this assumes that support for WebSockets has been built in
// when compiling the gateway. WebSockets support has not been tested
// when compiling the server. WebSockets support has not been tested
// as much as the REST API, so handle with care!
//
//
// If you have multiple options available, and want to let the library
// autodetect the best way to contact your gateway (or pool of gateways),
// autodetect the best way to contact your server (or pool of servers),
// you can also pass an array of servers, e.g., to provide alternative
// means of access (e.g., try WebSockets first and, if that fails, fall
// back to plain HTTP) or just have failover servers:
Expand Down
2 changes: 1 addition & 1 deletion html/footer.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<p>Janus WebRTC Gateway &copy; <a href="http://www.meetecho.com">Meetecho</a> 2014-2018</p>
<p>Janus WebRTC Server &copy; <a href="http://www.meetecho.com">Meetecho</a> 2014-2018</p>
Loading

0 comments on commit f88f34f

Please sign in to comment.