Exposing DTLS transport state from TransportChannel.

webrtc/p2p/base/transportchannel.h

 /*
  *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 28 matching lines @@
 // Used to indicate channel's connection state.
 enum TransportChannelState {
   STATE_INIT,
   STATE_CONNECTING,  // Will enter this state once a connection is created
   STATE_COMPLETED,
   STATE_FAILED
 };
 
 // A TransportChannel represents one logical stream of packets that are sent
 // between the two sides of a session.
+// TODO(deadbeef): This interface currently represents the unity of an ICE
+// transport and a DTLS transport. They need to be separated apart.
 class TransportChannel : public sigslot::has_slots<> {
  public:
   TransportChannel(const std::string& transport_name, int component)
       : transport_name_(transport_name),
         component_(component),
         writable_(false),
         receiving_(false) {}
   virtual ~TransportChannel() {}
 
   // TODO(guoweis) - Make this pure virtual once all subclasses of
   // TransportChannel have this defined.
   virtual TransportChannelState GetState() const {
     return TransportChannelState::STATE_CONNECTING;
   }
 
   // TODO(mallinath) - Remove this API, as it's no longer useful.
   // Returns the session id of this channel.
   virtual const std::string SessionId() const { return std::string(); }
 
   const std::string& transport_name() const { return transport_name_; }
   int component() const { return component_; }
 
   // Returns the states of this channel.  Each time one of these states changes,
   // a signal is raised.  These states are aggregated by the TransportManager.
   bool writable() const { return writable_; }
   bool receiving() const { return receiving_; }
+  DtlsTransportState dtls_transport_state() const {
+    return dtls_transport_state_;
+  }

[pthatcher1, 2015/10/20 20:28:07]

I agree with the type name (DtlsTransportState), but I think we might want to
call this dtls_state().

[Taylor Brandstetter, 2015/10/21 16:28:16]

That's what I had originally, then I renamed it halfway through... Guess I
should go with my gut more often. :)

   sigslot::signal1<TransportChannel*> SignalWritableState;
   // Emitted when the TransportChannel's ability to send has changed.
   sigslot::signal1<TransportChannel*> SignalReadyToSend;
   sigslot::signal1<TransportChannel*> SignalReceivingState;
+  // Emitted when the DtlsTransportState has changed.
+  sigslot::signal1<TransportChannel*> SignalDtlsTransportState;

[pthatcher1, 2015/10/20 20:28:07]

And this SignalDtlsState.

[Taylor Brandstetter, 2015/10/21 16:28:16]

Done.

 
   // Attempts to send the given packet.  The return value is < 0 on failure.
   // TODO: Remove the default argument once channel code is updated.
   virtual int SendPacket(const char* data, size_t len,
                          const rtc::PacketOptions& options,
                          int flags = 0) = 0;
 
   // Sets a socket option on this channel.  Note that not all options are
   // supported by all transport types.
   virtual int SetOption(rtc::Socket::Option opt, int value) = 0;
@@ skipping 62 matching lines @@
  protected:
   // TODO(honghaiz): Remove this once chromium's unit tests no longer call it.
   void set_readable(bool readable) { set_receiving(readable); }
 
   // Sets the writable state, signaling if necessary.
   void set_writable(bool writable);
 
   // Sets the receiving state, signaling if necessary.
   void set_receiving(bool receiving);
 
+  // Sets the DTLS state, signaling if necessary.
+  void set_dtls_transport_state(DtlsTransportState state);

[pthatcher1, 2015/10/20 20:28:06]

And this set_dtls_state.

[Taylor Brandstetter, 2015/10/21 16:28:16]

Done.

+
  private:
   // Used mostly for debugging.
   std::string transport_name_;
   int component_;
   bool writable_;
   bool receiving_;
+  DtlsTransportState dtls_transport_state_ = DTLS_TRANSPORT_NEW;

[pthatcher1, 2015/10/20 20:28:07]

And this dtls_state_ :).

[Taylor Brandstetter, 2015/10/21 16:28:16]

Done.

 
   RTC_DISALLOW_COPY_AND_ASSIGN(TransportChannel);
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_P2P_BASE_TRANSPORTCHANNEL_H_