gecko-dev/media/mtransport
Nils Ohlmeier [:drno] 6d382efd5e Bug 1253198: add WebRtcIce prefix to all ICE unit tests. r=bwc
MozReview-Commit-ID: 5wD8Dl9ETkB

--HG--
extra : rebase_source : edf942c35be1d4caba5501b9395a70953eaa8344
2016-03-03 01:40:52 -08:00
..
build Bug 1216444 - Remove GKMEDIAS_SHARED_LIBRARY. r=mshal 2015-10-21 14:47:22 +09:00
test Bug 1253198: add WebRtcIce prefix to all ICE unit tests. r=bwc 2016-03-03 01:40:52 -08:00
testlib Bug 950660: Part 4: Bridge TCPSocketChild to nr_socket r=bwc,jdm 2015-01-05 15:49:50 +08:00
third_party Bug 1252777: skip over ICE TCP host candidate creation failures. r=bwc 2016-03-02 01:27:01 -08:00
README
common.build Bug 1186590 - Part 1 - Enable interface prioritizer on all platforms. r=drno 2015-09-02 15:06:58 -05:00
databuffer.h Backed out changeset 2cb094627289 (bug 822129) for cppunittest orange 2015-06-05 14:16:56 -07:00
dtlsidentity.cpp Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04:00
dtlsidentity.h Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04:00
gonk_addrs.cpp Bug 1167132 - Part 15: [NetworkManager] Move network information into a separate interface (NetworkInterfaceList). r=echen 2015-07-29 02:16:00 -04:00
logging.h Bug 1165515 - Part 13-2: Replace usage of PRLogModuleLevel and PR_LOG_*. rs=froydnj 2015-06-03 15:25:57 -07:00
m_cpp_utils.h
moz.build Bug 1251737 - Remove remaining references to MOZILLA_XPCOMRT_API from media. r=jesup 2016-02-27 11:12:07 -08:00
nr_socket_prsock.cpp Bug 1252777: skip over ICE TCP host candidate creation failures. r=bwc 2016-03-02 01:27:01 -08:00
nr_socket_prsock.h Bug 1251737 - Remove remaining references to MOZILLA_XPCOMRT_API from media. r=jesup 2016-02-27 11:12:07 -08:00
nr_timer.cpp Bug 1157057 - Rewrite the handling of the nsITimer object in nrappkitTimerCallback; r=ekr 2015-05-15 08:39:54 -04:00
nricectx.cpp Bug 1251737 - Remove remaining references to MOZILLA_XPCOMRT_API from media. r=jesup 2016-02-27 11:12:07 -08:00
nricectx.h Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
nricemediastream.cpp Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
nricemediastream.h Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
nriceresolver.cpp Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04:00
nriceresolver.h Bug 1200763 - Remove hard-coded STUN IP address from ice_unittest, and do a DNS lookup instead. r=drno 2015-09-04 10:21:12 -05:00
nriceresolverfake.cpp Bug 797262 - IPV6 support for webrtc. r=drno 2015-04-22 15:02:50 -05:00
nriceresolverfake.h Bug 797262 - IPV6 support for webrtc. r=drno 2015-04-22 15:02:50 -05:00
nrinterfaceprioritizer.cpp Bug 1208176 - Part 1: Add a couple of interface names. r=drno 2015-10-06 15:06:36 -05:00
nrinterfaceprioritizer.h
rlogringbuffer.cpp Bug 1221786: clear about:webrtc logs for private browsing sessions. r=jib 2016-01-26 08:08:25 -08:00
rlogringbuffer.h Bug 1221786: clear about:webrtc logs for private browsing sessions. r=jib 2016-01-26 08:08:25 -08:00
runnable_utils.h Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04:00
sigslot.h
simpletokenbucket.cpp
simpletokenbucket.h Bug 1182996 - Fix and add missing namespace comments. rs=ehsan 2015-07-13 08:25:42 -07:00
stun_udp_socket_filter.cpp Bug 1251737 - Remove remaining references to MOZILLA_XPCOMRT_API from media. r=jesup 2016-02-27 11:12:07 -08:00
stun_udp_socket_filter.h Bug 1145354: Add SingletonThreadHolder for media/mtransport, and use it for mtransport IPC IO r=bwc 2015-05-29 10:13:33 -04:00
test_nr_socket.cpp Bug 1252171: Update last_used_ on TCP port mappings when they are used, similar to UDP. r=drno 2016-02-29 13:04:42 -06:00
test_nr_socket.h Bug 1231973 - Allow NAT simulator to be enabled with the pref system. r=drno 2015-12-16 14:26:02 -06:00
transportflow.cpp Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
transportflow.h Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
transportlayer.cpp Bug 1237909 part 1 - Remove unused TransportLayer::RunOnThread function. r=bwc 2016-01-25 14:52:34 +11:00
transportlayer.h Bug 1237909 part 1 - Remove unused TransportLayer::RunOnThread function. r=bwc 2016-01-25 14:52:34 +11:00
transportlayerdtls.cpp Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
transportlayerdtls.h Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
transportlayerice.cpp Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04:00
transportlayerice.h Bug 1251714 - use UniquePtr instead of ScopedDeletePtr in media/; r=jesup 2016-03-02 15:28:27 -05:00
transportlayerlog.cpp
transportlayerlog.h
transportlayerloopback.cpp Bug 1214269 - read multiple DTLS packets from NSS if present. r=mt r=jesup 2015-11-03 17:21:35 -08:00
transportlayerloopback.h Bug 1214269 - read multiple DTLS packets from NSS if present. r=mt r=jesup 2015-11-03 17:21:35 -08:00
transportlayerprsock.cpp
transportlayerprsock.h Bug 1207245 - part 6 - rename nsRefPtr<T> to RefPtr<T>; r=ehsan; a=Tomcat 2015-10-18 01:24:48 -04: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.