The Tor Browser: media/mtransport/nricemediastream.h@97036ab72558 (annotated)

media/mtransport/nricemediastream.h@97036ab72558 (annotated)

media/mtransport/nricemediastream.h

Tue, 06 Jan 2015 21:39:09 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Tue, 06 Jan 2015 21:39:09 +0100
branch: TOR_BUG_9701
changeset 8: 97036ab72558
permissions: -rw-r--r--

Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim: set ts=2 et sw=2 tw=80: */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 // Original author: ekr@rtfm.com
 // Some of this code is cut-and-pasted from nICEr. Copyright is:
 /*
 Copyright (c) 2007, Adobe Systems, Incorporated
 All rights reserved.
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of Adobe Systems, Network Resonance nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 // This is a wrapper around the nICEr ICE stack
 #ifndef nricemediastream_h__
 #define nricemediastream_h__
 #include <string>
 #include <vector>
 #include "sigslot.h"
 #include "mozilla/RefPtr.h"
 #include "mozilla/Scoped.h"
 #include "nsCOMPtr.h"
 #include "nsIEventTarget.h"
 #include "nsITimer.h"
 #include "m_cpp_utils.h"
 namespace mozilla {
 typedef struct nr_ice_media_stream_ nr_ice_media_stream;
 class NrIceCtx;
 struct NrIceAddr {
   std::string host;
   uint16_t port;
   std::string transport;
 };
 /* A summary of a candidate, for use in asking which candidate
    pair is active */
 struct NrIceCandidate {
   enum Type {
     ICE_HOST,
     ICE_SERVER_REFLEXIVE,
     ICE_PEER_REFLEXIVE,
     ICE_RELAYED
   };
   NrIceAddr cand_addr;
   NrIceAddr local_addr;
   Type type;
   std::string codeword;
 };
 struct NrIceCandidatePair {
   enum State {
     STATE_FROZEN,
     STATE_WAITING,
     STATE_IN_PROGRESS,
     STATE_FAILED,
     STATE_SUCCEEDED,
     STATE_CANCELLED
   };
   State state;
   uint64_t priority;
   // Set regardless of who nominated it. Does not necessarily mean that it is
   // ready to be selected (ie; nominated by peer, but our check has not
   // succeeded yet.) Note: since this implementation uses aggressive nomination,
   // when we are the controlling agent, this will always be set if the pair is
   // in STATE_SUCCEEDED.
   bool nominated;
   // Set if this candidate pair has been selected. Note: Since we are using
   // aggressive nomination, this could change frequently as ICE runs.
   bool selected;
   NrIceCandidate local;
   NrIceCandidate remote;
   // TODO(bcampen@mozilla.com): Is it important to put the foundation in here?
   std::string codeword;
 };
 // Abstract base class for opaque values.
 class NrIceOpaque {
  public:
   virtual ~NrIceOpaque() {}
 };
 class NrIceMediaStream {
  public:
   static RefPtr<NrIceMediaStream> Create(NrIceCtx *ctx,
                                          const std::string& name,
                                          int components);
   ~NrIceMediaStream();
   enum State { ICE_CONNECTING, ICE_OPEN, ICE_CLOSED};
   State state() const { return state_; }
   // The name of the stream
   const std::string& name() const { return name_; }
   // Get all the candidates
   std::vector<std::string> GetCandidates() const;
   nsresult GetLocalCandidates(std::vector<NrIceCandidate>* candidates) const;
   nsresult GetRemoteCandidates(std::vector<NrIceCandidate>* candidates) const;
   // Get all candidate pairs, whether in the check list or triggered check
   // queue, in priority order. |out_pairs| is cleared before being filled.
   nsresult GetCandidatePairs(std::vector<NrIceCandidatePair>* out_pairs) const;
   // Get the default candidate as host and port
   nsresult GetDefaultCandidate(int component, std::string *host, int *port);
   // Parse remote attributes
   nsresult ParseAttributes(std::vector<std::string>& candidates);
   // Parse trickle ICE candidate
   nsresult ParseTrickleCandidate(const std::string& candidate);
   // Disable a component
   nsresult DisableComponent(int component);
   // Get the candidate pair currently active. It's the
   // caller's responsibility to free these.
   nsresult GetActivePair(int component,
                          NrIceCandidate** local, NrIceCandidate** remote);
   // The number of components
   int components() const { return components_; }
   // The underlying nICEr stream
   nr_ice_media_stream *stream() { return stream_; }
   // Signals to indicate events. API users can (and should)
   // register for these.
   // Send a packet
   nsresult SendPacket(int component_id, const unsigned char *data, size_t len);
   // Set your state to ready. Called by the NrIceCtx;
   void Ready();
   // Close the stream. Called by the NrIceCtx.
   // Different from the destructor because other people
   // might be holding RefPtrs but we want those writes to fail once
   // the context has been destroyed.
   void Close();
   // Set an opaque value. Owned by the media stream.
   void SetOpaque(NrIceOpaque *opaque) { opaque_ = opaque; }
   // Get the opaque
   NrIceOpaque* opaque() const { return opaque_; }
   sigslot::signal2<NrIceMediaStream *, const std::string& >
   SignalCandidate;  // A new ICE candidate:
   sigslot::signal1<NrIceMediaStream *> SignalReady;  // Candidate pair ready.
   sigslot::signal1<NrIceMediaStream *> SignalFailed;  // Candidate pair failed.
   sigslot::signal4<NrIceMediaStream *, int, const unsigned char *, int>
   SignalPacketReceived;  // Incoming packet
   NS_INLINE_DECL_THREADSAFE_REFCOUNTING(NrIceMediaStream)
  private:
   NrIceMediaStream(NrIceCtx *ctx,  const std::string& name,
                    int components) :
       state_(ICE_CONNECTING),
       ctx_(ctx),
       name_(name),
       components_(components),
       stream_(nullptr),
       opaque_(nullptr) {}
   DISALLOW_COPY_ASSIGN(NrIceMediaStream);
   State state_;
   NrIceCtx *ctx_;
   const std::string name_;
   const int components_;
   nr_ice_media_stream *stream_;
   ScopedDeletePtr<NrIceOpaque> opaque_;
 };
 }  // close namespace
 #endif

The Tor Browser / annotate

media/mtransport/nricemediastream.h@97036ab72558 (annotated)

media/mtransport/nricemediastream.h