b10f32f9b2
Many of these interfaces are not intuitive, or are the way they are for complex historical reasons, so it would be nice to document these things for future developers. Also, many nonstandard things (such as RTCConfiguration options) were not documented at all before this CL. BUG=webrtc:7131 TBR=pthatcher@webrtc.org NOTRY=True Review-Url: https://codereview.webrtc.org/2680273002 Cr-Commit-Position: refs/heads/master@{#16485}
92 lines
2.9 KiB
C++
92 lines
2.9 KiB
C++
/*
|
|
* Copyright 2012 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.
|
|
*/
|
|
|
|
// TODO(deadbeef): Move this out of api/; it's an implementation detail and
|
|
// shouldn't be used externally.
|
|
|
|
#ifndef WEBRTC_API_JSEPICECANDIDATE_H_
|
|
#define WEBRTC_API_JSEPICECANDIDATE_H_
|
|
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "webrtc/api/jsep.h"
|
|
#include "webrtc/base/constructormagic.h"
|
|
#include "webrtc/p2p/base/candidate.h"
|
|
|
|
namespace webrtc {
|
|
|
|
// Implementation of IceCandidateInterface.
|
|
class JsepIceCandidate : public IceCandidateInterface {
|
|
public:
|
|
JsepIceCandidate(const std::string& sdp_mid, int sdp_mline_index);
|
|
JsepIceCandidate(const std::string& sdp_mid, int sdp_mline_index,
|
|
const cricket::Candidate& candidate);
|
|
~JsepIceCandidate();
|
|
// |err| may be NULL.
|
|
bool Initialize(const std::string& sdp, SdpParseError* err);
|
|
void SetCandidate(const cricket::Candidate& candidate) {
|
|
candidate_ = candidate;
|
|
}
|
|
|
|
virtual std::string sdp_mid() const { return sdp_mid_; }
|
|
virtual int sdp_mline_index() const { return sdp_mline_index_; }
|
|
virtual const cricket::Candidate& candidate() const {
|
|
return candidate_;
|
|
}
|
|
|
|
virtual bool ToString(std::string* out) const;
|
|
|
|
private:
|
|
std::string sdp_mid_;
|
|
int sdp_mline_index_;
|
|
cricket::Candidate candidate_;
|
|
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(JsepIceCandidate);
|
|
};
|
|
|
|
// Implementation of IceCandidateCollection which stores JsepIceCandidates.
|
|
class JsepCandidateCollection : public IceCandidateCollection {
|
|
public:
|
|
JsepCandidateCollection() {}
|
|
// Move constructor is defined so that a vector of JsepCandidateCollections
|
|
// can be resized.
|
|
JsepCandidateCollection(JsepCandidateCollection&& o)
|
|
: candidates_(std::move(o.candidates_)) {}
|
|
~JsepCandidateCollection();
|
|
virtual size_t count() const {
|
|
return candidates_.size();
|
|
}
|
|
virtual bool HasCandidate(const IceCandidateInterface* candidate) const;
|
|
// Adds and takes ownership of the JsepIceCandidate.
|
|
// TODO(deadbeef): Make this use an std::unique_ptr<>, so ownership logic is
|
|
// more clear.
|
|
virtual void add(JsepIceCandidate* candidate) {
|
|
candidates_.push_back(candidate);
|
|
}
|
|
virtual const IceCandidateInterface* at(size_t index) const {
|
|
return candidates_[index];
|
|
}
|
|
// Removes the candidate that has a matching address and protocol.
|
|
//
|
|
// Returns the number of candidates that were removed.
|
|
size_t remove(const cricket::Candidate& candidate);
|
|
|
|
private:
|
|
std::vector<JsepIceCandidate*> candidates_;
|
|
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(JsepCandidateCollection);
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // WEBRTC_API_JSEPICECANDIDATE_H_
|