gecko-dev/media/mtransport
Sylvestre Ledru 364ecfb0c7 Bug 1338086 - Remove useless else blocks in order to reduce complexity in media/mtransport/ r=drno
MozReview-Commit-ID: 9Hvf7kGOi2s

--HG--
extra : rebase_source : d7a182a4b6fc02030f3e8d0eb5cbd75c0f5ff117
2017-02-14 15:08:29 +01:00
..
build Bug 1309129: enable redirecting of nICEr logging to NSPR logging. r=bwc 2016-10-11 00:17:26 -07:00
test Bug 1338086 - Remove useless else blocks in order to reduce complexity in media/mtransport/ r=drno 2017-02-14 15:08:29 +01:00
testlib Bug 1286877 - do not set c-basic-offset for python-mode; r=gps 2016-07-14 10:16:42 -06:00
third_party Bug 1338384: added STUN bandwidth attribute. r=bwc 2017-02-10 12:33:26 -08:00
README
common.build Bug 1309129: enable redirecting of nICEr logging to NSPR logging. r=bwc 2016-10-11 00:17:26 -07:00
databuffer.h
dtlsidentity.cpp Bug 1337358 - Converts for(...; ...; ...) loops to use the new range-based loops in C++11 in media/mtransport/ r=bwc=jesup 2017-02-13 14:42:00 +01:00
dtlsidentity.h Bug 1323998 - Stop using Scoped.h NSS types in dtlsidentity.(cpp|h) and nricectx.cpp. r=mt 2016-12-21 22:09:10 +08:00
gonk_addrs.cpp
logging.h Bug 1219468: Remove the rest of the non-LazyLogModules in webrtc, except for cppunit tests r=erahm,ng 2017-01-27 23:35:17 -05:00
m_cpp_utils.h
moz.build Bug 1286877 - do not set c-basic-offset for python-mode; r=gps 2016-07-14 10:16:42 -06:00
nr_socket_prsock.cpp Bug 1336507 - Part 2: Move some TLS related stuff from |connect| to |create|, so it is better reflected in candidate labels/codeword. r=drno 2017-02-03 16:47:05 -06:00
nr_socket_prsock.h Bug 1312319 - Add a NS_INLINE_DECL_PURE_VIRTUAL_REFCOUNTING macro and replace existing pure-virtual AddRef/Release declarations. r=froydnj 2017-01-25 14:51:34 -05:00
nr_timer.cpp Bug 1018486 - Part 9: Changes to account for modifications to clang plugin, r=ehsan 2016-09-07 10:50:47 -04:00
nricectx.cpp Bug 1337358 - Converts for(...; ...; ...) loops to use the new range-based loops in C++11 in media/mtransport/ r=bwc=jesup 2017-02-13 14:42:00 +01:00
nricectx.h Bug 1338273 - initialize NrIceStats vars to zero. r=drno 2017-02-13 11:58:57 -06:00
nricectxhandler.cpp Bug 1325536 - ice telemetry. r=bsmedberg,chutten,drno 2017-01-11 19:57:03 -06:00
nricectxhandler.h Bug 1325536 - ice telemetry. r=bsmedberg,chutten,drno 2017-01-11 19:57:03 -06:00
nricemediastream.cpp Bug 1337358 - Converts for(...; ...; ...) loops to use the new range-based loops in C++11 in media/mtransport/ r=bwc=jesup 2017-02-13 14:42:00 +01:00
nricemediastream.h
nriceresolver.cpp
nriceresolver.h
nriceresolverfake.cpp
nriceresolverfake.h
nrinterfaceprioritizer.cpp Bug 1337358 - Converts for(...; ...; ...) loops to use the new range-based loops in C++11 in media/mtransport/ r=bwc=jesup 2017-02-13 14:42:00 +01:00
nrinterfaceprioritizer.h
rlogconnector.cpp Bug 1309129: enable redirecting of nICEr logging to NSPR logging. r=bwc 2016-10-11 00:17:26 -07:00
rlogconnector.h Bug 1309129: enable redirecting of nICEr logging to NSPR logging. r=bwc 2016-10-11 00:17:26 -07:00
runnable_utils.h
sigslot.h
simpletokenbucket.cpp
simpletokenbucket.h
stun_socket_filter.cpp
stun_socket_filter.h
test_nr_socket.cpp Bug 1338086 - Remove useless else blocks in order to reduce complexity in media/mtransport/ r=drno 2017-02-14 15:08:29 +01:00
test_nr_socket.h Bug 1056934 - Part 2: Test-case for TURN TLS. r=drno 2017-01-03 12:28:13 -06:00
transportflow.cpp Bug 1337358 - Converts for(...; ...; ...) loops to use the new range-based loops in C++11 in media/mtransport/ r=bwc=jesup 2017-02-13 14:42:00 +01:00
transportflow.h
transportlayer.cpp
transportlayer.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00
transportlayerdtls.cpp Bug 1336182 - Part 1: Add DTLS handshake time telemetry. r=bsmedberg,drno 2017-02-03 17:01:05 -06:00
transportlayerdtls.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00
transportlayerice.cpp
transportlayerice.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00
transportlayerlog.cpp Bug 1338086 - Remove useless else blocks in order to reduce complexity in media/mtransport/ r=drno 2017-02-14 15:08:29 +01:00
transportlayerlog.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00
transportlayerloopback.cpp
transportlayerloopback.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00
transportlayerprsock.cpp
transportlayerprsock.h Bug 1336182 - Part 2: Use "override" keyword to silence some warnings about inconsistency. r=drno 2017-02-06 16:44:14 -06:00

README

This is a generic media transport system for WebRTC.

The basic model is that you have a TransportFlow which contains a
series of TransportLayers, each of which gets an opportunity to
manipulate data up and down the stack (think SysV STREAMS or a
standard networking stack). You can also address individual
sublayers to manipulate them or to bypass reading and writing
at an upper layer; WebRTC uses this to implement DTLS-SRTP.


DATAFLOW MODEL
Unlike the existing nsSocket I/O system, this is a push rather
than a pull system. Clients of the interface do writes downward
with SendPacket() and receive notification of incoming packets
via callbacks registed via sigslot.h. It is the responsibility
of the bottom layer (or any other layer which needs to reference
external events) to arrange for that somehow; typically by
using nsITimer or the SocketTansportService.

This sort of push model is a much better fit for the demands
of WebRTC, expecially because ICE contexts span multiple
network transports.


THREADING MODEL
There are no thread locks. It is the responsibility of the caller to
arrange that any given TransportLayer/TransportFlow is only
manipulated in one thread at once. One good way to do this is to run
everything on the STS thread. Many of the existing layer implementations
(TransportLayerPrsock, TransportLayerIce, TransportLayerLoopback)
already run on STS so in those cases you must run on STS, though
you can do setup on the main thread and then activate them on the
STS.


EXISTING TRANSPORT LAYERS
The following transport layers are currently implemented:

* DTLS -- a wrapper around NSS's DTLS [RFC 6347] stack
* ICE  -- a wrapper around the nICEr ICE [RFC 5245] stack.
* Prsock -- a wrapper around NSPR sockets
* Loopback -- a loopback IO mechanism
* Logging -- a passthrough that just logs its data

The last three are primarily for debugging.