blob: 7f35a232f3f1220c0fa8afd1d6f72bc52c334730 [file] [log] [blame]
* Copyright 2018 The WebRTC project authors. All Rights Reserved.
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
#include "api/ice_transport_interface.h"
#include "api/rtc_error.h"
#include "api/scoped_refptr.h"
#include "rtc_base/ref_count.h"
namespace webrtc {
// States of a DTLS transport, corresponding to the JS API specification.
enum class DtlsTransportState {
kNew, // Has not started negotiating yet.
kConnecting, // In the process of negotiating a secure connection.
kConnected, // Completed negotiation and verified fingerprints.
kClosed, // Intentionally closed.
kFailed, // Failure due to an error or failing to verify a remote
// fingerprint.
// This object gives snapshot information about the changeable state of a
// DTLSTransport.
class DtlsTransportInformation {
explicit DtlsTransportInformation(DtlsTransportState state) : state_(state) {}
DtlsTransportState state() const { return state_; }
// TODO(hta): Add remote certificate access
DtlsTransportState state_;
class DtlsTransportObserverInterface {
// This callback carries information about the state of the transport.
// The argument is a pass-by-value snapshot of the state.
virtual void OnStateChange(DtlsTransportInformation info) = 0;
// This callback is called when an error occurs, causing the transport
// to go to the kFailed state.
virtual void OnError(RTCError error) = 0;
virtual ~DtlsTransportObserverInterface() = default;
// A DTLS transport, as represented to the outside world.
// This object is created on the network thread, and can only be
// accessed on that thread, except for functions explicitly marked otherwise.
// References can be held by other threads, and destruction can therefore
// be initiated by other threads.
class DtlsTransportInterface : public rtc::RefCountInterface {
// Returns a pointer to the ICE transport that is owned by the DTLS transport.
virtual rtc::scoped_refptr<IceTransportInterface> ice_transport() = 0;
// Returns information on the state of the DtlsTransport.
// This function can be called from other threads.
virtual DtlsTransportInformation Information() = 0;
// Observer management.
virtual void RegisterObserver(DtlsTransportObserverInterface* observer) = 0;
virtual void UnregisterObserver() = 0;
} // namespace webrtc