gecko-dev/media/mtransport
Tom Bannister 988d18881f Bug 1434710 - Replaced all instances of mozilla::IndexSequence, mozilla::MakeIndexSequence and mozilla::IndexSequenceFor with std::index_sequence, std::make_index_sequence and std::index_sequence_for and removed mfbt/IndexSequence.h. r=botond
MozReview-Commit-ID: 1Ema7TUNr5v

--HG--
extra : rebase_source : e5bb164dbe19993214e8c16f92b0a1f5d2ff3fa1
2018-04-09 21:12:13 +10:00
..
build Bug 1446583: Update location for setting trace-pc coverage flags for LibFuzzer r=drno 2018-03-17 18:07:58 +01:00
fuzztest Bug 1446583: Update location for setting trace-pc coverage flags for LibFuzzer r=drno 2018-03-17 18:07:58 +01:00
ipc Bug 1343743 - Part6: Pass a labeled event target to StunAddrsRequestChild's constructor., r=bwc 2017-06-12 00:25:00 +02:00
test Backed out 4 changesets (bug 525063) on request from Andi. a=backout 2018-04-13 16:01:28 +03:00
third_party Bug 1434531 - fix missing TCP relay candidates. r=drno 2018-02-02 16:03:51 -06:00
README Bug 1426059: removed transportlayerprsock code. r=bwc 2017-12-18 20:30:05 -08:00
common.build Bug 1426059: removed transportlayerprsock code. r=bwc 2017-12-18 20:30:05 -08:00
databuffer.h
dtlsidentity.cpp Bug 1372977 - Use nullptr in /media and /dom/media (clang-tidy: modernize-use-nullptr). r=bwc 2017-06-28 15:38:00 -04:00
dtlsidentity.h
logging.h
m_cpp_utils.h
moz.build Bug 1446583: Update location for setting trace-pc coverage flags for LibFuzzer r=drno 2018-03-17 18:07:58 +01:00
nr_socket_prsock.cpp Bug 1442404: Don't spin STS when shutting down the mtransport thread. r=drno 2018-03-06 12:30:16 -06:00
nr_socket_prsock.h Bug 1411977 - Part 2: Stop using sync dispatch and queue jumping with SingletonThreadHolder. r=drno 2018-01-25 09:53:04 -06:00
nr_timer.cpp Bug 1404198: Part 2g - Switch to NS_NewTimer* in media. r=njn 2017-10-15 23:14:33 -07:00
nricectx.cpp Bug 1290948 - Part 8: Don't cause ICE to fail if there's no streams to establish. r+drno r=drno 2017-09-29 09:16:14 -05:00
nricectx.h Backed out 4 changesets (bug 525063) on request from Andi. a=backout 2018-04-13 16:01:28 +03:00
nricectxhandler.cpp
nricectxhandler.h
nricemediastream.cpp Bug 1414171 - pt 2 - Sort ICE stats by componentId on about:webrtc. r=drno 2018-01-30 22:23:54 -06:00
nricemediastream.h Bug 1414171 - pt 2 - Sort ICE stats by componentId on about:webrtc. r=drno 2018-01-30 22:23:54 -06:00
nriceresolver.cpp Bug 1372977 - Use nullptr in /media and /dom/media (clang-tidy: modernize-use-nullptr). r=bwc 2017-06-28 15:38:00 -04:00
nriceresolver.h
nriceresolverfake.cpp Bug 1372977 - Use nullptr in /media and /dom/media (clang-tidy: modernize-use-nullptr). r=bwc 2017-06-28 15:38:00 -04:00
nriceresolverfake.h Backed out 4 changesets (bug 525063) on request from Andi. a=backout 2018-04-13 16:01:28 +03:00
nricestunaddr.cpp
nricestunaddr.h
nrinterfaceprioritizer.cpp Bug 1408218: ignore EUI 64 and Teredo addresses if not needed. r=bwc 2017-10-13 08:32:16 -07:00
nrinterfaceprioritizer.h
rlogconnector.cpp
rlogconnector.h
runnable_utils.h Bug 1434710 - Replaced all instances of mozilla::IndexSequence, mozilla::MakeIndexSequence and mozilla::IndexSequenceFor with std::index_sequence, std::make_index_sequence and std::index_sequence_for and removed mfbt/IndexSequence.h. r=botond 2018-04-09 21:12:13 +10:00
sigslot.h Bug 1428535 - Add missing override specifiers to overridden virtual functions. r=froydnj 2017-11-05 19:37:28 -08:00
simpletokenbucket.cpp
simpletokenbucket.h
stun_socket_filter.cpp
stun_socket_filter.h
test_nr_socket.cpp Backed out 4 changesets (bug 525063) on request from Andi. a=backout 2018-04-13 16:01:28 +03:00
test_nr_socket.h Bug 1355947 - Add NatDelegate to TestNat; r=bwc 2017-06-13 10:08:45 -04:00
transportflow.cpp Bug 1411977 - Part 4: Only try to dispatch the release of TransportLayers when there is a target thread. r=drno 2018-01-25 09:55:12 -06:00
transportflow.h
transportlayer.cpp
transportlayer.h
transportlayerdtls.cpp Bug 1404198: Part 2g - Switch to NS_NewTimer* in media. r=njn 2017-10-15 23:14:33 -07:00
transportlayerdtls.h
transportlayerice.cpp Bug 1290948 - Part 6: Remove some unused code. r+drno r=drno 2017-08-23 16:15:11 -05:00
transportlayerice.h Bug 1290948 - Part 6: Remove some unused code. r+drno r=drno 2017-08-23 16:15:11 -05:00
transportlayerlog.cpp
transportlayerlog.h
transportlayerloopback.cpp Bug 1404198: Part 2g - Switch to NS_NewTimer* in media. r=njn 2017-10-15 23:14:33 -07:00
transportlayerloopback.h Bug 1382172 - Name nsITimerCallback instances in native implementation. r=billm 2017-07-27 02:18:20 +08: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
(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.
* Loopback -- a loopback IO mechanism
* Logging -- a passthrough that just logs its data

The last two are primarily for debugging.