Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1153)

Side by Side Diff: webrtc/api/datachannel.cc

Issue 2514883002: Create //webrtc/api:libjingle_peerconnection_api + refactorings. (Closed)
Patch Set: Rebase Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « webrtc/api/datachannel.h ('k') | webrtc/api/datachannel_unittest.cc » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 /*
2 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11 #include "webrtc/api/datachannel.h"
12
13 #include <memory>
14 #include <string>
15
16 #include "webrtc/api/sctputils.h"
17 #include "webrtc/base/checks.h"
18 #include "webrtc/base/logging.h"
19 #include "webrtc/base/refcount.h"
20 #include "webrtc/media/sctp/sctptransportinternal.h"
21
22 namespace webrtc {
23
24 static size_t kMaxQueuedReceivedDataBytes = 16 * 1024 * 1024;
25 static size_t kMaxQueuedSendDataBytes = 16 * 1024 * 1024;
26
27 enum {
28 MSG_CHANNELREADY,
29 };
30
31 bool SctpSidAllocator::AllocateSid(rtc::SSLRole role, int* sid) {
32 int potential_sid = (role == rtc::SSL_CLIENT) ? 0 : 1;
33 while (!IsSidAvailable(potential_sid)) {
34 potential_sid += 2;
35 if (potential_sid > static_cast<int>(cricket::kMaxSctpSid)) {
36 return false;
37 }
38 }
39
40 *sid = potential_sid;
41 used_sids_.insert(potential_sid);
42 return true;
43 }
44
45 bool SctpSidAllocator::ReserveSid(int sid) {
46 if (!IsSidAvailable(sid)) {
47 return false;
48 }
49 used_sids_.insert(sid);
50 return true;
51 }
52
53 void SctpSidAllocator::ReleaseSid(int sid) {
54 auto it = used_sids_.find(sid);
55 if (it != used_sids_.end()) {
56 used_sids_.erase(it);
57 }
58 }
59
60 bool SctpSidAllocator::IsSidAvailable(int sid) const {
61 if (sid < static_cast<int>(cricket::kMinSctpSid) ||
62 sid > static_cast<int>(cricket::kMaxSctpSid)) {
63 return false;
64 }
65 return used_sids_.find(sid) == used_sids_.end();
66 }
67
68 DataChannel::PacketQueue::PacketQueue() : byte_count_(0) {}
69
70 DataChannel::PacketQueue::~PacketQueue() {
71 Clear();
72 }
73
74 bool DataChannel::PacketQueue::Empty() const {
75 return packets_.empty();
76 }
77
78 DataBuffer* DataChannel::PacketQueue::Front() {
79 return packets_.front();
80 }
81
82 void DataChannel::PacketQueue::Pop() {
83 if (packets_.empty()) {
84 return;
85 }
86
87 byte_count_ -= packets_.front()->size();
88 packets_.pop_front();
89 }
90
91 void DataChannel::PacketQueue::Push(DataBuffer* packet) {
92 byte_count_ += packet->size();
93 packets_.push_back(packet);
94 }
95
96 void DataChannel::PacketQueue::Clear() {
97 while (!packets_.empty()) {
98 delete packets_.front();
99 packets_.pop_front();
100 }
101 byte_count_ = 0;
102 }
103
104 void DataChannel::PacketQueue::Swap(PacketQueue* other) {
105 size_t other_byte_count = other->byte_count_;
106 other->byte_count_ = byte_count_;
107 byte_count_ = other_byte_count;
108
109 other->packets_.swap(packets_);
110 }
111
112 rtc::scoped_refptr<DataChannel> DataChannel::Create(
113 DataChannelProviderInterface* provider,
114 cricket::DataChannelType dct,
115 const std::string& label,
116 const InternalDataChannelInit& config) {
117 rtc::scoped_refptr<DataChannel> channel(
118 new rtc::RefCountedObject<DataChannel>(provider, dct, label));
119 if (!channel->Init(config)) {
120 return NULL;
121 }
122 return channel;
123 }
124
125 DataChannel::DataChannel(
126 DataChannelProviderInterface* provider,
127 cricket::DataChannelType dct,
128 const std::string& label)
129 : label_(label),
130 observer_(nullptr),
131 state_(kConnecting),
132 messages_sent_(0),
133 bytes_sent_(0),
134 messages_received_(0),
135 bytes_received_(0),
136 data_channel_type_(dct),
137 provider_(provider),
138 handshake_state_(kHandshakeInit),
139 connected_to_provider_(false),
140 send_ssrc_set_(false),
141 receive_ssrc_set_(false),
142 writable_(false),
143 send_ssrc_(0),
144 receive_ssrc_(0) {
145 }
146
147 bool DataChannel::Init(const InternalDataChannelInit& config) {
148 if (data_channel_type_ == cricket::DCT_RTP) {
149 if (config.reliable ||
150 config.id != -1 ||
151 config.maxRetransmits != -1 ||
152 config.maxRetransmitTime != -1) {
153 LOG(LS_ERROR) << "Failed to initialize the RTP data channel due to "
154 << "invalid DataChannelInit.";
155 return false;
156 }
157 handshake_state_ = kHandshakeReady;
158 } else if (data_channel_type_ == cricket::DCT_SCTP) {
159 if (config.id < -1 ||
160 config.maxRetransmits < -1 ||
161 config.maxRetransmitTime < -1) {
162 LOG(LS_ERROR) << "Failed to initialize the SCTP data channel due to "
163 << "invalid DataChannelInit.";
164 return false;
165 }
166 if (config.maxRetransmits != -1 && config.maxRetransmitTime != -1) {
167 LOG(LS_ERROR) <<
168 "maxRetransmits and maxRetransmitTime should not be both set.";
169 return false;
170 }
171 config_ = config;
172
173 switch (config_.open_handshake_role) {
174 case webrtc::InternalDataChannelInit::kNone: // pre-negotiated
175 handshake_state_ = kHandshakeReady;
176 break;
177 case webrtc::InternalDataChannelInit::kOpener:
178 handshake_state_ = kHandshakeShouldSendOpen;
179 break;
180 case webrtc::InternalDataChannelInit::kAcker:
181 handshake_state_ = kHandshakeShouldSendAck;
182 break;
183 };
184
185 // Try to connect to the transport in case the transport channel already
186 // exists.
187 OnTransportChannelCreated();
188
189 // Checks if the transport is ready to send because the initial channel
190 // ready signal may have been sent before the DataChannel creation.
191 // This has to be done async because the upper layer objects (e.g.
192 // Chrome glue and WebKit) are not wired up properly until after this
193 // function returns.
194 if (provider_->ReadyToSendData()) {
195 rtc::Thread::Current()->Post(RTC_FROM_HERE, this, MSG_CHANNELREADY, NULL);
196 }
197 }
198
199 return true;
200 }
201
202 DataChannel::~DataChannel() {}
203
204 void DataChannel::RegisterObserver(DataChannelObserver* observer) {
205 observer_ = observer;
206 DeliverQueuedReceivedData();
207 }
208
209 void DataChannel::UnregisterObserver() {
210 observer_ = NULL;
211 }
212
213 bool DataChannel::reliable() const {
214 if (data_channel_type_ == cricket::DCT_RTP) {
215 return false;
216 } else {
217 return config_.maxRetransmits == -1 &&
218 config_.maxRetransmitTime == -1;
219 }
220 }
221
222 uint64_t DataChannel::buffered_amount() const {
223 return queued_send_data_.byte_count();
224 }
225
226 void DataChannel::Close() {
227 if (state_ == kClosed)
228 return;
229 send_ssrc_ = 0;
230 send_ssrc_set_ = false;
231 SetState(kClosing);
232 UpdateState();
233 }
234
235 bool DataChannel::Send(const DataBuffer& buffer) {
236 if (state_ != kOpen) {
237 return false;
238 }
239
240 // TODO(jiayl): the spec is unclear about if the remote side should get the
241 // onmessage event. We need to figure out the expected behavior and change the
242 // code accordingly.
243 if (buffer.size() == 0) {
244 return true;
245 }
246
247 // If the queue is non-empty, we're waiting for SignalReadyToSend,
248 // so just add to the end of the queue and keep waiting.
249 if (!queued_send_data_.Empty()) {
250 // Only SCTP DataChannel queues the outgoing data when the transport is
251 // blocked.
252 RTC_DCHECK(data_channel_type_ == cricket::DCT_SCTP);
253 if (!QueueSendDataMessage(buffer)) {
254 Close();
255 }
256 return true;
257 }
258
259 bool success = SendDataMessage(buffer, true);
260 if (data_channel_type_ == cricket::DCT_RTP) {
261 return success;
262 }
263
264 // Always return true for SCTP DataChannel per the spec.
265 return true;
266 }
267
268 void DataChannel::SetReceiveSsrc(uint32_t receive_ssrc) {
269 RTC_DCHECK(data_channel_type_ == cricket::DCT_RTP);
270
271 if (receive_ssrc_set_) {
272 return;
273 }
274 receive_ssrc_ = receive_ssrc;
275 receive_ssrc_set_ = true;
276 UpdateState();
277 }
278
279 // The remote peer request that this channel shall be closed.
280 void DataChannel::RemotePeerRequestClose() {
281 DoClose();
282 }
283
284 void DataChannel::SetSctpSid(int sid) {
285 RTC_DCHECK(config_.id < 0 && sid >= 0 &&
286 data_channel_type_ == cricket::DCT_SCTP);
287 if (config_.id == sid) {
288 return;
289 }
290
291 config_.id = sid;
292 provider_->AddSctpDataStream(sid);
293 }
294
295 void DataChannel::OnTransportChannelCreated() {
296 RTC_DCHECK(data_channel_type_ == cricket::DCT_SCTP);
297 if (!connected_to_provider_) {
298 connected_to_provider_ = provider_->ConnectDataChannel(this);
299 }
300 // The sid may have been unassigned when provider_->ConnectDataChannel was
301 // done. So always add the streams even if connected_to_provider_ is true.
302 if (config_.id >= 0) {
303 provider_->AddSctpDataStream(config_.id);
304 }
305 }
306
307 void DataChannel::OnTransportChannelDestroyed() {
308 // This method needs to synchronously close the data channel, which means any
309 // queued data needs to be discarded.
310 queued_send_data_.Clear();
311 queued_control_data_.Clear();
312 DoClose();
313 }
314
315 void DataChannel::SetSendSsrc(uint32_t send_ssrc) {
316 RTC_DCHECK(data_channel_type_ == cricket::DCT_RTP);
317 if (send_ssrc_set_) {
318 return;
319 }
320 send_ssrc_ = send_ssrc;
321 send_ssrc_set_ = true;
322 UpdateState();
323 }
324
325 void DataChannel::OnMessage(rtc::Message* msg) {
326 switch (msg->message_id) {
327 case MSG_CHANNELREADY:
328 OnChannelReady(true);
329 break;
330 }
331 }
332
333 void DataChannel::OnDataReceived(const cricket::ReceiveDataParams& params,
334 const rtc::CopyOnWriteBuffer& payload) {
335 if (data_channel_type_ == cricket::DCT_RTP && params.ssrc != receive_ssrc_) {
336 return;
337 }
338 if (data_channel_type_ == cricket::DCT_SCTP && params.sid != config_.id) {
339 return;
340 }
341
342 if (params.type == cricket::DMT_CONTROL) {
343 RTC_DCHECK(data_channel_type_ == cricket::DCT_SCTP);
344 if (handshake_state_ != kHandshakeWaitingForAck) {
345 // Ignore it if we are not expecting an ACK message.
346 LOG(LS_WARNING) << "DataChannel received unexpected CONTROL message, "
347 << "sid = " << params.sid;
348 return;
349 }
350 if (ParseDataChannelOpenAckMessage(payload)) {
351 // We can send unordered as soon as we receive the ACK message.
352 handshake_state_ = kHandshakeReady;
353 LOG(LS_INFO) << "DataChannel received OPEN_ACK message, sid = "
354 << params.sid;
355 } else {
356 LOG(LS_WARNING) << "DataChannel failed to parse OPEN_ACK message, sid = "
357 << params.sid;
358 }
359 return;
360 }
361
362 RTC_DCHECK(params.type == cricket::DMT_BINARY ||
363 params.type == cricket::DMT_TEXT);
364
365 LOG(LS_VERBOSE) << "DataChannel received DATA message, sid = " << params.sid;
366 // We can send unordered as soon as we receive any DATA message since the
367 // remote side must have received the OPEN (and old clients do not send
368 // OPEN_ACK).
369 if (handshake_state_ == kHandshakeWaitingForAck) {
370 handshake_state_ = kHandshakeReady;
371 }
372
373 bool binary = (params.type == cricket::DMT_BINARY);
374 std::unique_ptr<DataBuffer> buffer(new DataBuffer(payload, binary));
375 if (state_ == kOpen && observer_) {
376 ++messages_received_;
377 bytes_received_ += buffer->size();
378 observer_->OnMessage(*buffer.get());
379 } else {
380 if (queued_received_data_.byte_count() + payload.size() >
381 kMaxQueuedReceivedDataBytes) {
382 LOG(LS_ERROR) << "Queued received data exceeds the max buffer size.";
383
384 queued_received_data_.Clear();
385 if (data_channel_type_ != cricket::DCT_RTP) {
386 Close();
387 }
388
389 return;
390 }
391 queued_received_data_.Push(buffer.release());
392 }
393 }
394
395 void DataChannel::OnStreamClosedRemotely(int sid) {
396 if (data_channel_type_ == cricket::DCT_SCTP && sid == config_.id) {
397 Close();
398 }
399 }
400
401 void DataChannel::OnChannelReady(bool writable) {
402 writable_ = writable;
403 if (!writable) {
404 return;
405 }
406
407 SendQueuedControlMessages();
408 SendQueuedDataMessages();
409 UpdateState();
410 }
411
412 void DataChannel::DoClose() {
413 if (state_ == kClosed)
414 return;
415
416 receive_ssrc_set_ = false;
417 send_ssrc_set_ = false;
418 SetState(kClosing);
419 UpdateState();
420 }
421
422 void DataChannel::UpdateState() {
423 // UpdateState determines what to do from a few state variables. Include
424 // all conditions required for each state transition here for
425 // clarity. OnChannelReady(true) will send any queued data and then invoke
426 // UpdateState().
427 switch (state_) {
428 case kConnecting: {
429 if (send_ssrc_set_ == receive_ssrc_set_) {
430 if (data_channel_type_ == cricket::DCT_RTP && !connected_to_provider_) {
431 connected_to_provider_ = provider_->ConnectDataChannel(this);
432 }
433 if (connected_to_provider_) {
434 if (handshake_state_ == kHandshakeShouldSendOpen) {
435 rtc::CopyOnWriteBuffer payload;
436 WriteDataChannelOpenMessage(label_, config_, &payload);
437 SendControlMessage(payload);
438 } else if (handshake_state_ == kHandshakeShouldSendAck) {
439 rtc::CopyOnWriteBuffer payload;
440 WriteDataChannelOpenAckMessage(&payload);
441 SendControlMessage(payload);
442 }
443 if (writable_ &&
444 (handshake_state_ == kHandshakeReady ||
445 handshake_state_ == kHandshakeWaitingForAck)) {
446 SetState(kOpen);
447 // If we have received buffers before the channel got writable.
448 // Deliver them now.
449 DeliverQueuedReceivedData();
450 }
451 }
452 }
453 break;
454 }
455 case kOpen: {
456 break;
457 }
458 case kClosing: {
459 if (queued_send_data_.Empty() && queued_control_data_.Empty()) {
460 if (connected_to_provider_) {
461 DisconnectFromProvider();
462 }
463
464 if (!connected_to_provider_ && !send_ssrc_set_ && !receive_ssrc_set_) {
465 SetState(kClosed);
466 }
467 }
468 break;
469 }
470 case kClosed:
471 break;
472 }
473 }
474
475 void DataChannel::SetState(DataState state) {
476 if (state_ == state) {
477 return;
478 }
479
480 state_ = state;
481 if (observer_) {
482 observer_->OnStateChange();
483 }
484 if (state_ == kOpen) {
485 SignalOpened(this);
486 } else if (state_ == kClosed) {
487 SignalClosed(this);
488 }
489 }
490
491 void DataChannel::DisconnectFromProvider() {
492 if (!connected_to_provider_)
493 return;
494
495 provider_->DisconnectDataChannel(this);
496 connected_to_provider_ = false;
497
498 if (data_channel_type_ == cricket::DCT_SCTP && config_.id >= 0) {
499 provider_->RemoveSctpDataStream(config_.id);
500 }
501 }
502
503 void DataChannel::DeliverQueuedReceivedData() {
504 if (!observer_) {
505 return;
506 }
507
508 while (!queued_received_data_.Empty()) {
509 std::unique_ptr<DataBuffer> buffer(queued_received_data_.Front());
510 ++messages_received_;
511 bytes_received_ += buffer->size();
512 observer_->OnMessage(*buffer);
513 queued_received_data_.Pop();
514 }
515 }
516
517 void DataChannel::SendQueuedDataMessages() {
518 if (queued_send_data_.Empty()) {
519 return;
520 }
521
522 RTC_DCHECK(state_ == kOpen || state_ == kClosing);
523
524 uint64_t start_buffered_amount = buffered_amount();
525 while (!queued_send_data_.Empty()) {
526 DataBuffer* buffer = queued_send_data_.Front();
527 if (!SendDataMessage(*buffer, false)) {
528 // Leave the message in the queue if sending is aborted.
529 break;
530 }
531 queued_send_data_.Pop();
532 delete buffer;
533 }
534
535 if (observer_ && buffered_amount() < start_buffered_amount) {
536 observer_->OnBufferedAmountChange(start_buffered_amount);
537 }
538 }
539
540 bool DataChannel::SendDataMessage(const DataBuffer& buffer,
541 bool queue_if_blocked) {
542 cricket::SendDataParams send_params;
543
544 if (data_channel_type_ == cricket::DCT_SCTP) {
545 send_params.ordered = config_.ordered;
546 // Send as ordered if it is still going through OPEN/ACK signaling.
547 if (handshake_state_ != kHandshakeReady && !config_.ordered) {
548 send_params.ordered = true;
549 LOG(LS_VERBOSE) << "Sending data as ordered for unordered DataChannel "
550 << "because the OPEN_ACK message has not been received.";
551 }
552
553 send_params.max_rtx_count = config_.maxRetransmits;
554 send_params.max_rtx_ms = config_.maxRetransmitTime;
555 send_params.sid = config_.id;
556 } else {
557 send_params.ssrc = send_ssrc_;
558 }
559 send_params.type = buffer.binary ? cricket::DMT_BINARY : cricket::DMT_TEXT;
560
561 cricket::SendDataResult send_result = cricket::SDR_SUCCESS;
562 bool success = provider_->SendData(send_params, buffer.data, &send_result);
563
564 if (success) {
565 ++messages_sent_;
566 bytes_sent_ += buffer.size();
567 return true;
568 }
569
570 if (data_channel_type_ != cricket::DCT_SCTP) {
571 return false;
572 }
573
574 if (send_result == cricket::SDR_BLOCK) {
575 if (!queue_if_blocked || QueueSendDataMessage(buffer)) {
576 return false;
577 }
578 }
579 // Close the channel if the error is not SDR_BLOCK, or if queuing the
580 // message failed.
581 LOG(LS_ERROR) << "Closing the DataChannel due to a failure to send data, "
582 << "send_result = " << send_result;
583 Close();
584
585 return false;
586 }
587
588 bool DataChannel::QueueSendDataMessage(const DataBuffer& buffer) {
589 size_t start_buffered_amount = buffered_amount();
590 if (start_buffered_amount >= kMaxQueuedSendDataBytes) {
591 LOG(LS_ERROR) << "Can't buffer any more data for the data channel.";
592 return false;
593 }
594 queued_send_data_.Push(new DataBuffer(buffer));
595
596 // The buffer can have length zero, in which case there is no change.
597 if (observer_ && buffered_amount() > start_buffered_amount) {
598 observer_->OnBufferedAmountChange(start_buffered_amount);
599 }
600 return true;
601 }
602
603 void DataChannel::SendQueuedControlMessages() {
604 PacketQueue control_packets;
605 control_packets.Swap(&queued_control_data_);
606
607 while (!control_packets.Empty()) {
608 std::unique_ptr<DataBuffer> buf(control_packets.Front());
609 SendControlMessage(buf->data);
610 control_packets.Pop();
611 }
612 }
613
614 void DataChannel::QueueControlMessage(const rtc::CopyOnWriteBuffer& buffer) {
615 queued_control_data_.Push(new DataBuffer(buffer, true));
616 }
617
618 bool DataChannel::SendControlMessage(const rtc::CopyOnWriteBuffer& buffer) {
619 bool is_open_message = handshake_state_ == kHandshakeShouldSendOpen;
620
621 RTC_DCHECK(data_channel_type_ == cricket::DCT_SCTP && writable_ &&
622 config_.id >= 0 && (!is_open_message || !config_.negotiated));
623
624 cricket::SendDataParams send_params;
625 send_params.sid = config_.id;
626 // Send data as ordered before we receive any message from the remote peer to
627 // make sure the remote peer will not receive any data before it receives the
628 // OPEN message.
629 send_params.ordered = config_.ordered || is_open_message;
630 send_params.type = cricket::DMT_CONTROL;
631
632 cricket::SendDataResult send_result = cricket::SDR_SUCCESS;
633 bool retval = provider_->SendData(send_params, buffer, &send_result);
634 if (retval) {
635 LOG(LS_INFO) << "Sent CONTROL message on channel " << config_.id;
636
637 if (handshake_state_ == kHandshakeShouldSendAck) {
638 handshake_state_ = kHandshakeReady;
639 } else if (handshake_state_ == kHandshakeShouldSendOpen) {
640 handshake_state_ = kHandshakeWaitingForAck;
641 }
642 } else if (send_result == cricket::SDR_BLOCK) {
643 QueueControlMessage(buffer);
644 } else {
645 LOG(LS_ERROR) << "Closing the DataChannel due to a failure to send"
646 << " the CONTROL message, send_result = " << send_result;
647 Close();
648 }
649 return retval;
650 }
651
652 } // namespace webrtc
OLDNEW
« no previous file with comments | « webrtc/api/datachannel.h ('k') | webrtc/api/datachannel_unittest.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698