ozone: evdev: Sync caps lock LED state to evdev
[chromium-blink-merge.git] / net / quic / quic_connection.h
blob789a7e52e0ed80bbf24295a48bd65bac32c25200
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 //
5 // The entity that handles framing writes for a Quic client or server.
6 // Each QuicSession will have a connection associated with it.
7 //
8 // On the server side, the Dispatcher handles the raw reads, and hands off
9 // packets via ProcessUdpPacket for framing and processing.
11 // On the client side, the Connection handles the raw reads, as well as the
12 // processing.
14 // Note: this class is not thread-safe.
16 #ifndef NET_QUIC_QUIC_CONNECTION_H_
17 #define NET_QUIC_QUIC_CONNECTION_H_
19 #include <stddef.h>
20 #include <deque>
21 #include <list>
22 #include <map>
23 #include <queue>
24 #include <string>
25 #include <vector>
27 #include "base/basictypes.h"
28 #include "base/logging.h"
29 #include "net/base/iovec.h"
30 #include "net/base/ip_endpoint.h"
31 #include "net/quic/iovector.h"
32 #include "net/quic/quic_ack_notifier.h"
33 #include "net/quic/quic_ack_notifier_manager.h"
34 #include "net/quic/quic_alarm.h"
35 #include "net/quic/quic_blocked_writer_interface.h"
36 #include "net/quic/quic_connection_stats.h"
37 #include "net/quic/quic_packet_creator.h"
38 #include "net/quic/quic_packet_generator.h"
39 #include "net/quic/quic_packet_writer.h"
40 #include "net/quic/quic_protocol.h"
41 #include "net/quic/quic_received_packet_manager.h"
42 #include "net/quic/quic_sent_entropy_manager.h"
43 #include "net/quic/quic_sent_packet_manager.h"
44 #include "net/quic/quic_time.h"
45 #include "net/quic/quic_types.h"
47 namespace net {
49 class QuicClock;
50 class QuicConfig;
51 class QuicConnection;
52 class QuicDecrypter;
53 class QuicEncrypter;
54 class QuicFecGroup;
55 class QuicRandom;
57 namespace test {
58 class PacketSavingConnection;
59 class QuicConnectionPeer;
60 } // namespace test
62 // Class that receives callbacks from the connection when frames are received
63 // and when other interesting events happen.
64 class NET_EXPORT_PRIVATE QuicConnectionVisitorInterface {
65 public:
66 virtual ~QuicConnectionVisitorInterface() {}
68 // A simple visitor interface for dealing with data frames.
69 virtual void OnStreamFrames(const std::vector<QuicStreamFrame>& frames) = 0;
71 // The session should process all WINDOW_UPDATE frames, adjusting both stream
72 // and connection level flow control windows.
73 virtual void OnWindowUpdateFrames(
74 const std::vector<QuicWindowUpdateFrame>& frames) = 0;
76 // BLOCKED frames tell us that the peer believes it is flow control blocked on
77 // a specified stream. If the session at this end disagrees, something has
78 // gone wrong with our flow control accounting.
79 virtual void OnBlockedFrames(const std::vector<QuicBlockedFrame>& frames) = 0;
81 // Called when the stream is reset by the peer.
82 virtual void OnRstStream(const QuicRstStreamFrame& frame) = 0;
84 // Called when the connection is going away according to the peer.
85 virtual void OnGoAway(const QuicGoAwayFrame& frame) = 0;
87 // Called when the connection is closed either locally by the framer, or
88 // remotely by the peer.
89 virtual void OnConnectionClosed(QuicErrorCode error, bool from_peer) = 0;
91 // Called when the connection failed to write because the socket was blocked.
92 virtual void OnWriteBlocked() = 0;
94 // Called once a specific QUIC version is agreed by both endpoints.
95 virtual void OnSuccessfulVersionNegotiation(const QuicVersion& version) = 0;
97 // Called when a blocked socket becomes writable.
98 virtual void OnCanWrite() = 0;
100 // Called when the connection experiences a change in congestion window.
101 virtual void OnCongestionWindowChange(QuicTime now) = 0;
103 // Called to ask if the visitor wants to schedule write resumption as it both
104 // has pending data to write, and is able to write (e.g. based on flow control
105 // limits).
106 // Writes may be pending because they were write-blocked, congestion-throttled
107 // or yielded to other connections.
108 virtual bool WillingAndAbleToWrite() const = 0;
110 // Called to ask if any handshake messages are pending in this visitor.
111 virtual bool HasPendingHandshake() const = 0;
113 // Called to ask if any streams are open in this visitor, excluding the
114 // reserved crypto and headers stream.
115 virtual bool HasOpenDataStreams() const = 0;
118 // Interface which gets callbacks from the QuicConnection at interesting
119 // points. Implementations must not mutate the state of the connection
120 // as a result of these callbacks.
121 class NET_EXPORT_PRIVATE QuicConnectionDebugVisitor
122 : public QuicPacketGenerator::DebugDelegate,
123 public QuicSentPacketManager::DebugDelegate {
124 public:
125 ~QuicConnectionDebugVisitor() override {}
127 // Called when a packet has been sent.
128 virtual void OnPacketSent(const SerializedPacket& serialized_packet,
129 QuicPacketSequenceNumber original_sequence_number,
130 EncryptionLevel level,
131 TransmissionType transmission_type,
132 const QuicEncryptedPacket& packet,
133 QuicTime sent_time) {}
135 // Called when a packet has been received, but before it is
136 // validated or parsed.
137 virtual void OnPacketReceived(const IPEndPoint& self_address,
138 const IPEndPoint& peer_address,
139 const QuicEncryptedPacket& packet) {}
141 // Called when a packet is received with a connection id that does not
142 // match the ID of this connection.
143 virtual void OnIncorrectConnectionId(
144 QuicConnectionId connection_id) {}
146 // Called when an undecryptable packet has been received.
147 virtual void OnUndecryptablePacket() {}
149 // Called when a duplicate packet has been received.
150 virtual void OnDuplicatePacket(QuicPacketSequenceNumber sequence_number) {}
152 // Called when the protocol version on the received packet doensn't match
153 // current protocol version of the connection.
154 virtual void OnProtocolVersionMismatch(QuicVersion version) {}
156 // Called when the complete header of a packet has been parsed.
157 virtual void OnPacketHeader(const QuicPacketHeader& header) {}
159 // Called when a StreamFrame has been parsed.
160 virtual void OnStreamFrame(const QuicStreamFrame& frame) {}
162 // Called when a AckFrame has been parsed.
163 virtual void OnAckFrame(const QuicAckFrame& frame) {}
165 // Called when a StopWaitingFrame has been parsed.
166 virtual void OnStopWaitingFrame(const QuicStopWaitingFrame& frame) {}
168 // Called when a Ping has been parsed.
169 virtual void OnPingFrame(const QuicPingFrame& frame) {}
171 // Called when a GoAway has been parsed.
172 virtual void OnGoAwayFrame(const QuicGoAwayFrame& frame) {}
174 // Called when a RstStreamFrame has been parsed.
175 virtual void OnRstStreamFrame(const QuicRstStreamFrame& frame) {}
177 // Called when a ConnectionCloseFrame has been parsed.
178 virtual void OnConnectionCloseFrame(
179 const QuicConnectionCloseFrame& frame) {}
181 // Called when a WindowUpdate has been parsed.
182 virtual void OnWindowUpdateFrame(const QuicWindowUpdateFrame& frame) {}
184 // Called when a BlockedFrame has been parsed.
185 virtual void OnBlockedFrame(const QuicBlockedFrame& frame) {}
187 // Called when a public reset packet has been received.
188 virtual void OnPublicResetPacket(const QuicPublicResetPacket& packet) {}
190 // Called when a version negotiation packet has been received.
191 virtual void OnVersionNegotiationPacket(
192 const QuicVersionNegotiationPacket& packet) {}
194 // Called after a packet has been successfully parsed which results
195 // in the revival of a packet via FEC.
196 virtual void OnRevivedPacket(const QuicPacketHeader& revived_header,
197 base::StringPiece payload) {}
199 // Called when the connection is closed.
200 virtual void OnConnectionClosed(QuicErrorCode error, bool from_peer) {}
202 // Called when the version negotiation is successful.
203 virtual void OnSuccessfulVersionNegotiation(const QuicVersion& version) {}
206 class NET_EXPORT_PRIVATE QuicConnectionHelperInterface {
207 public:
208 virtual ~QuicConnectionHelperInterface() {}
210 // Returns a QuicClock to be used for all time related functions.
211 virtual const QuicClock* GetClock() const = 0;
213 // Returns a QuicRandom to be used for all random number related functions.
214 virtual QuicRandom* GetRandomGenerator() = 0;
216 // Creates a new platform-specific alarm which will be configured to
217 // notify |delegate| when the alarm fires. Caller takes ownership
218 // of the new alarm, which will not yet be "set" to fire.
219 virtual QuicAlarm* CreateAlarm(QuicAlarm::Delegate* delegate) = 0;
222 class NET_EXPORT_PRIVATE QuicConnection
223 : public QuicFramerVisitorInterface,
224 public QuicBlockedWriterInterface,
225 public QuicPacketGenerator::DelegateInterface,
226 public QuicSentPacketManager::NetworkChangeVisitor {
227 public:
228 enum AckBundling {
229 NO_ACK = 0,
230 SEND_ACK = 1,
231 BUNDLE_PENDING_ACK = 2,
234 class PacketWriterFactory {
235 public:
236 virtual ~PacketWriterFactory() {}
238 virtual QuicPacketWriter* Create(QuicConnection* connection) const = 0;
241 // Constructs a new QuicConnection for |connection_id| and |address|. Invokes
242 // writer_factory->Create() to get a writer; |owns_writer| specifies whether
243 // the connection takes ownership of the returned writer. |helper| must
244 // outlive this connection.
245 QuicConnection(QuicConnectionId connection_id,
246 IPEndPoint address,
247 QuicConnectionHelperInterface* helper,
248 const PacketWriterFactory& writer_factory,
249 bool owns_writer,
250 bool is_server,
251 bool is_secure,
252 const QuicVersionVector& supported_versions);
253 ~QuicConnection() override;
255 // Sets connection parameters from the supplied |config|.
256 void SetFromConfig(const QuicConfig& config);
258 // Called by the Session when the client has provided CachedNetworkParameters.
259 // Returns true if this changes the initial connection state.
260 virtual bool ResumeConnectionState(
261 const CachedNetworkParameters& cached_network_params);
263 // Sets the number of active streams on the connection for congestion control.
264 void SetNumOpenStreams(size_t num_streams);
266 // Send the data in |data| to the peer in as few packets as possible.
267 // Returns a pair with the number of bytes consumed from data, and a boolean
268 // indicating if the fin bit was consumed. This does not indicate the data
269 // has been sent on the wire: it may have been turned into a packet and queued
270 // if the socket was unexpectedly blocked. |fec_protection| indicates if
271 // data is to be FEC protected. Note that data that is sent immediately
272 // following MUST_FEC_PROTECT data may get protected by falling within the
273 // same FEC group.
274 // If |delegate| is provided, then it will be informed once ACKs have been
275 // received for all the packets written in this call.
276 // The |delegate| is not owned by the QuicConnection and must outlive it.
277 QuicConsumedData SendStreamData(QuicStreamId id,
278 const IOVector& data,
279 QuicStreamOffset offset,
280 bool fin,
281 FecProtection fec_protection,
282 QuicAckNotifier::DelegateInterface* delegate);
284 // Send a RST_STREAM frame to the peer.
285 virtual void SendRstStream(QuicStreamId id,
286 QuicRstStreamErrorCode error,
287 QuicStreamOffset bytes_written);
289 // Send a BLOCKED frame to the peer.
290 virtual void SendBlocked(QuicStreamId id);
292 // Send a WINDOW_UPDATE frame to the peer.
293 virtual void SendWindowUpdate(QuicStreamId id,
294 QuicStreamOffset byte_offset);
296 // Sends the connection close packet without affecting the state of the
297 // connection. This should only be called if the session is actively being
298 // destroyed: otherwise call SendConnectionCloseWithDetails instead.
299 virtual void SendConnectionClosePacket(QuicErrorCode error,
300 const std::string& details);
302 // Sends a connection close frame to the peer, and closes the connection by
303 // calling CloseConnection(notifying the visitor as it does so).
304 virtual void SendConnectionClose(QuicErrorCode error);
305 virtual void SendConnectionCloseWithDetails(QuicErrorCode error,
306 const std::string& details);
307 // Notifies the visitor of the close and marks the connection as disconnected.
308 void CloseConnection(QuicErrorCode error, bool from_peer) override;
309 virtual void SendGoAway(QuicErrorCode error,
310 QuicStreamId last_good_stream_id,
311 const std::string& reason);
313 // Returns statistics tracked for this connection.
314 const QuicConnectionStats& GetStats();
316 // Processes an incoming UDP packet (consisting of a QuicEncryptedPacket) from
317 // the peer. If processing this packet permits a packet to be revived from
318 // its FEC group that packet will be revived and processed.
319 virtual void ProcessUdpPacket(const IPEndPoint& self_address,
320 const IPEndPoint& peer_address,
321 const QuicEncryptedPacket& packet);
323 // QuicBlockedWriterInterface
324 // Called when the underlying connection becomes writable to allow queued
325 // writes to happen.
326 void OnCanWrite() override;
328 // Called when an error occurs while attempting to write a packet to the
329 // network.
330 void OnWriteError(int error_code);
332 // If the socket is not blocked, writes queued packets.
333 void WriteIfNotBlocked();
335 // The version of the protocol this connection is using.
336 QuicVersion version() const { return framer_.version(); }
338 // The versions of the protocol that this connection supports.
339 const QuicVersionVector& supported_versions() const {
340 return framer_.supported_versions();
343 // From QuicFramerVisitorInterface
344 void OnError(QuicFramer* framer) override;
345 bool OnProtocolVersionMismatch(QuicVersion received_version) override;
346 void OnPacket() override;
347 void OnPublicResetPacket(const QuicPublicResetPacket& packet) override;
348 void OnVersionNegotiationPacket(
349 const QuicVersionNegotiationPacket& packet) override;
350 void OnRevivedPacket() override;
351 bool OnUnauthenticatedPublicHeader(
352 const QuicPacketPublicHeader& header) override;
353 bool OnUnauthenticatedHeader(const QuicPacketHeader& header) override;
354 void OnDecryptedPacket(EncryptionLevel level) override;
355 bool OnPacketHeader(const QuicPacketHeader& header) override;
356 void OnFecProtectedPayload(base::StringPiece payload) override;
357 bool OnStreamFrame(const QuicStreamFrame& frame) override;
358 bool OnAckFrame(const QuicAckFrame& frame) override;
359 bool OnStopWaitingFrame(const QuicStopWaitingFrame& frame) override;
360 bool OnPingFrame(const QuicPingFrame& frame) override;
361 bool OnRstStreamFrame(const QuicRstStreamFrame& frame) override;
362 bool OnConnectionCloseFrame(const QuicConnectionCloseFrame& frame) override;
363 bool OnGoAwayFrame(const QuicGoAwayFrame& frame) override;
364 bool OnWindowUpdateFrame(const QuicWindowUpdateFrame& frame) override;
365 bool OnBlockedFrame(const QuicBlockedFrame& frame) override;
366 void OnFecData(const QuicFecData& fec) override;
367 void OnPacketComplete() override;
369 // QuicPacketGenerator::DelegateInterface
370 bool ShouldGeneratePacket(TransmissionType transmission_type,
371 HasRetransmittableData retransmittable,
372 IsHandshake handshake) override;
373 void PopulateAckFrame(QuicAckFrame* ack) override;
374 void PopulateStopWaitingFrame(QuicStopWaitingFrame* stop_waiting) override;
375 void OnSerializedPacket(const SerializedPacket& packet) override;
377 // QuicSentPacketManager::NetworkChangeVisitor
378 void OnCongestionWindowChange() override;
379 void OnRttChange() override;
381 // Called by the crypto stream when the handshake completes. In the server's
382 // case this is when the SHLO has been ACKed. Clients call this on receipt of
383 // the SHLO.
384 void OnHandshakeComplete();
386 // Accessors
387 void set_visitor(QuicConnectionVisitorInterface* visitor) {
388 visitor_ = visitor;
390 void set_debug_visitor(QuicConnectionDebugVisitor* debug_visitor) {
391 debug_visitor_ = debug_visitor;
392 packet_generator_.set_debug_delegate(debug_visitor);
393 sent_packet_manager_.set_debug_delegate(debug_visitor);
395 const IPEndPoint& self_address() const { return self_address_; }
396 const IPEndPoint& peer_address() const { return peer_address_; }
397 QuicConnectionId connection_id() const { return connection_id_; }
398 const QuicClock* clock() const { return clock_; }
399 QuicRandom* random_generator() const { return random_generator_; }
400 QuicByteCount max_packet_length() const;
401 void set_max_packet_length(QuicByteCount length);
403 bool connected() const { return connected_; }
405 // Must only be called on client connections.
406 const QuicVersionVector& server_supported_versions() const {
407 DCHECK(!is_server_);
408 return server_supported_versions_;
411 size_t NumFecGroups() const { return group_map_.size(); }
413 // Testing only.
414 size_t NumQueuedPackets() const { return queued_packets_.size(); }
416 QuicEncryptedPacket* ReleaseConnectionClosePacket() {
417 return connection_close_packet_.release();
420 // Returns true if the underlying UDP socket is writable, there is
421 // no queued data and the connection is not congestion-control
422 // blocked.
423 bool CanWriteStreamData();
425 // Returns true if the connection has queued packets or frames.
426 bool HasQueuedData() const;
428 // Sets the overall and idle state connection timeouts.
429 void SetNetworkTimeouts(QuicTime::Delta overall_timeout,
430 QuicTime::Delta idle_timeout);
432 // If the connection has timed out, this will close the connection.
433 // Otherwise, it will reschedule the timeout alarm.
434 void CheckForTimeout();
436 // Sends a ping, and resets the ping alarm.
437 void SendPing();
439 // Sets up a packet with an QuicAckFrame and sends it out.
440 void SendAck();
442 // Called when an RTO fires. Resets the retransmission alarm if there are
443 // remaining unacked packets.
444 void OnRetransmissionTimeout();
446 // Called when a data packet is sent. Starts an alarm if the data sent in
447 // |sequence_number| was FEC protected.
448 void MaybeSetFecAlarm(QuicPacketSequenceNumber sequence_number);
450 // Retransmits all unacked packets with retransmittable frames if
451 // |retransmission_type| is ALL_UNACKED_PACKETS, otherwise retransmits only
452 // initially encrypted packets. Used when the negotiated protocol version is
453 // different from what was initially assumed and when the initial encryption
454 // changes.
455 void RetransmitUnackedPackets(TransmissionType retransmission_type);
457 // Calls |sent_packet_manager_|'s NeuterUnencryptedPackets. Used when the
458 // connection becomes forward secure and hasn't received acks for all packets.
459 void NeuterUnencryptedPackets();
461 // Changes the encrypter used for level |level| to |encrypter|. The function
462 // takes ownership of |encrypter|.
463 void SetEncrypter(EncryptionLevel level, QuicEncrypter* encrypter);
464 const QuicEncrypter* encrypter(EncryptionLevel level) const;
466 // SetDefaultEncryptionLevel sets the encryption level that will be applied
467 // to new packets.
468 void SetDefaultEncryptionLevel(EncryptionLevel level);
470 // SetDecrypter sets the primary decrypter, replacing any that already exists,
471 // and takes ownership. If an alternative decrypter is in place then the
472 // function DCHECKs. This is intended for cases where one knows that future
473 // packets will be using the new decrypter and the previous decrypter is now
474 // obsolete. |level| indicates the encryption level of the new decrypter.
475 void SetDecrypter(QuicDecrypter* decrypter, EncryptionLevel level);
477 // SetAlternativeDecrypter sets a decrypter that may be used to decrypt
478 // future packets and takes ownership of it. |level| indicates the encryption
479 // level of the decrypter. If |latch_once_used| is true, then the first time
480 // that the decrypter is successful it will replace the primary decrypter.
481 // Otherwise both decrypters will remain active and the primary decrypter
482 // will be the one last used.
483 void SetAlternativeDecrypter(QuicDecrypter* decrypter,
484 EncryptionLevel level,
485 bool latch_once_used);
487 const QuicDecrypter* decrypter() const;
488 const QuicDecrypter* alternative_decrypter() const;
490 bool is_server() const { return is_server_; }
492 // Allow easy overriding of truncated connection IDs.
493 void set_can_truncate_connection_ids(bool can) {
494 can_truncate_connection_ids_ = can;
497 // Returns the underlying sent packet manager.
498 const QuicSentPacketManager& sent_packet_manager() const {
499 return sent_packet_manager_;
502 bool CanWrite(HasRetransmittableData retransmittable);
504 // Stores current batch state for connection, puts the connection
505 // into batch mode, and destruction restores the stored batch state.
506 // While the bundler is in scope, any generated frames are bundled
507 // as densely as possible into packets. In addition, this bundler
508 // can be configured to ensure that an ACK frame is included in the
509 // first packet created, if there's new ack information to be sent.
510 class ScopedPacketBundler {
511 public:
512 // In addition to all outgoing frames being bundled when the
513 // bundler is in scope, setting |include_ack| to true ensures that
514 // an ACK frame is opportunistically bundled with the first
515 // outgoing packet.
516 ScopedPacketBundler(QuicConnection* connection, AckBundling send_ack);
517 ~ScopedPacketBundler();
519 private:
520 QuicConnection* connection_;
521 bool already_in_batch_mode_;
524 QuicPacketSequenceNumber sequence_number_of_last_sent_packet() const {
525 return sequence_number_of_last_sent_packet_;
527 const QuicPacketWriter* writer() const { return writer_; }
529 bool is_secure() const { return is_secure_; }
531 protected:
532 // Packets which have not been written to the wire.
533 // Owns the QuicPacket* packet.
534 struct QueuedPacket {
535 QueuedPacket(SerializedPacket packet,
536 EncryptionLevel level);
537 QueuedPacket(SerializedPacket packet,
538 EncryptionLevel level,
539 TransmissionType transmission_type,
540 QuicPacketSequenceNumber original_sequence_number);
542 SerializedPacket serialized_packet;
543 const EncryptionLevel encryption_level;
544 TransmissionType transmission_type;
545 // The packet's original sequence number if it is a retransmission.
546 // Otherwise it must be 0.
547 QuicPacketSequenceNumber original_sequence_number;
550 // Do any work which logically would be done in OnPacket but can not be
551 // safely done until the packet is validated. Returns true if the packet
552 // can be handled, false otherwise.
553 virtual bool ProcessValidatedPacket();
555 // Send a packet to the peer, and takes ownership of the packet if the packet
556 // cannot be written immediately.
557 virtual void SendOrQueuePacket(QueuedPacket packet);
559 QuicConnectionHelperInterface* helper() { return helper_; }
561 // Selects and updates the version of the protocol being used by selecting a
562 // version from |available_versions| which is also supported. Returns true if
563 // such a version exists, false otherwise.
564 bool SelectMutualVersion(const QuicVersionVector& available_versions);
566 QuicPacketWriter* writer() { return writer_; }
568 bool peer_port_changed() const { return peer_port_changed_; }
570 private:
571 friend class test::QuicConnectionPeer;
572 friend class test::PacketSavingConnection;
574 typedef std::list<QueuedPacket> QueuedPacketList;
575 typedef std::map<QuicFecGroupNumber, QuicFecGroup*> FecGroupMap;
577 // Writes the given packet to socket, encrypted with packet's
578 // encryption_level. Returns true on successful write, and false if the writer
579 // was blocked and the write needs to be tried again. Notifies the
580 // SentPacketManager when the write is successful and sets
581 // retransmittable frames to nullptr.
582 // Saves the connection close packet for later transmission, even if the
583 // writer is write blocked.
584 bool WritePacket(QueuedPacket* packet);
586 // Does the main work of WritePacket, but does not delete the packet or
587 // retransmittable frames upon success.
588 bool WritePacketInner(QueuedPacket* packet);
590 // Make sure an ack we got from our peer is sane.
591 bool ValidateAckFrame(const QuicAckFrame& incoming_ack);
593 // Make sure a stop waiting we got from our peer is sane.
594 bool ValidateStopWaitingFrame(const QuicStopWaitingFrame& stop_waiting);
596 // Sends a version negotiation packet to the peer.
597 void SendVersionNegotiationPacket();
599 // Clears any accumulated frames from the last received packet.
600 void ClearLastFrames();
602 // Closes the connection if the sent or received packet manager are tracking
603 // too many outstanding packets.
604 void MaybeCloseIfTooManyOutstandingPackets();
606 // Writes as many queued packets as possible. The connection must not be
607 // blocked when this is called.
608 void WriteQueuedPackets();
610 // Writes as many pending retransmissions as possible.
611 void WritePendingRetransmissions();
613 // Returns true if the packet should be discarded and not sent.
614 bool ShouldDiscardPacket(const QueuedPacket& packet);
616 // Queues |packet| in the hopes that it can be decrypted in the
617 // future, when a new key is installed.
618 void QueueUndecryptablePacket(const QuicEncryptedPacket& packet);
620 // Attempts to process any queued undecryptable packets.
621 void MaybeProcessUndecryptablePackets();
623 // If a packet can be revived from the current FEC group, then
624 // revive and process the packet.
625 void MaybeProcessRevivedPacket();
627 void ProcessAckFrame(const QuicAckFrame& incoming_ack);
629 void ProcessStopWaitingFrame(const QuicStopWaitingFrame& stop_waiting);
631 // Queues an ack or sets the ack alarm when an incoming packet arrives that
632 // should be acked.
633 void MaybeQueueAck();
635 // Checks if the last packet should instigate an ack.
636 bool ShouldLastPacketInstigateAck() const;
638 // Checks if the peer is waiting for packets that have been given up on, and
639 // therefore an ack frame should be sent with a larger least_unacked.
640 void UpdateStopWaitingCount();
642 // Sends any packets which are a response to the last packet, including both
643 // acks and pending writes if an ack opened the congestion window.
644 void MaybeSendInResponseToPacket();
646 // Gets the least unacked sequence number, which is the next sequence number
647 // to be sent if there are no outstanding packets.
648 QuicPacketSequenceNumber GetLeastUnacked() const;
650 // Get the FEC group associate with the last processed packet or nullptr, if
651 // the group has already been deleted.
652 QuicFecGroup* GetFecGroup();
654 // Closes any FEC groups protecting packets before |sequence_number|.
655 void CloseFecGroupsBefore(QuicPacketSequenceNumber sequence_number);
657 // Sets the timeout alarm to the appropriate value, if any.
658 void SetTimeoutAlarm();
660 // Sets the ping alarm to the appropriate value, if any.
661 void SetPingAlarm();
663 // On arrival of a new packet, checks to see if the socket addresses have
664 // changed since the last packet we saw on this connection.
665 void CheckForAddressMigration(const IPEndPoint& self_address,
666 const IPEndPoint& peer_address);
668 HasRetransmittableData IsRetransmittable(const QueuedPacket& packet);
669 bool IsConnectionClose(const QueuedPacket& packet);
671 QuicFramer framer_;
672 QuicConnectionHelperInterface* helper_; // Not owned.
673 QuicPacketWriter* writer_; // Owned or not depending on |owns_writer_|.
674 bool owns_writer_;
675 // Encryption level for new packets. Should only be changed via
676 // SetDefaultEncryptionLevel().
677 EncryptionLevel encryption_level_;
678 bool has_forward_secure_encrypter_;
679 // The sequence number of the first packet which will be encrypted with the
680 // foward-secure encrypter, even if the peer has not started sending
681 // forward-secure packets.
682 QuicPacketSequenceNumber first_required_forward_secure_packet_;
683 const QuicClock* clock_;
684 QuicRandom* random_generator_;
686 const QuicConnectionId connection_id_;
687 // Address on the last successfully processed packet received from the
688 // client.
689 IPEndPoint self_address_;
690 IPEndPoint peer_address_;
691 // Used to store latest peer port to possibly migrate to later.
692 uint16 migrating_peer_port_;
694 // True if the last packet has gotten far enough in the framer to be
695 // decrypted.
696 bool last_packet_decrypted_;
697 bool last_packet_revived_; // True if the last packet was revived from FEC.
698 QuicByteCount last_size_; // Size of the last received packet.
699 EncryptionLevel last_decrypted_packet_level_;
700 QuicPacketHeader last_header_;
701 std::vector<QuicStreamFrame> last_stream_frames_;
702 std::vector<QuicAckFrame> last_ack_frames_;
703 std::vector<QuicStopWaitingFrame> last_stop_waiting_frames_;
704 std::vector<QuicRstStreamFrame> last_rst_frames_;
705 std::vector<QuicGoAwayFrame> last_goaway_frames_;
706 std::vector<QuicWindowUpdateFrame> last_window_update_frames_;
707 std::vector<QuicBlockedFrame> last_blocked_frames_;
708 std::vector<QuicPingFrame> last_ping_frames_;
709 std::vector<QuicConnectionCloseFrame> last_close_frames_;
711 // Track some peer state so we can do less bookkeeping
712 // Largest sequence sent by the peer which had an ack frame (latest ack info).
713 QuicPacketSequenceNumber largest_seen_packet_with_ack_;
715 // Largest sequence number sent by the peer which had a stop waiting frame.
716 QuicPacketSequenceNumber largest_seen_packet_with_stop_waiting_;
718 // Collection of packets which were received before encryption was
719 // established, but which could not be decrypted. We buffer these on
720 // the assumption that they could not be processed because they were
721 // sent with the INITIAL encryption and the CHLO message was lost.
722 std::deque<QuicEncryptedPacket*> undecryptable_packets_;
724 // Maximum number of undecryptable packets the connection will store.
725 size_t max_undecryptable_packets_;
727 // When the version negotiation packet could not be sent because the socket
728 // was not writable, this is set to true.
729 bool pending_version_negotiation_packet_;
731 // When packets could not be sent because the socket was not writable,
732 // they are added to this list. All corresponding frames are in
733 // unacked_packets_ if they are to be retransmitted.
734 QueuedPacketList queued_packets_;
736 // Contains the connection close packet if the connection has been closed.
737 scoped_ptr<QuicEncryptedPacket> connection_close_packet_;
739 // When true, the connection does not send a close packet on timeout.
740 bool silent_close_enabled_;
742 FecGroupMap group_map_;
744 QuicReceivedPacketManager received_packet_manager_;
745 QuicSentEntropyManager sent_entropy_manager_;
747 // Indicates whether an ack should be sent the next time we try to write.
748 bool ack_queued_;
749 // Indicates how many consecutive packets have arrived without sending an ack.
750 QuicPacketCount num_packets_received_since_last_ack_sent_;
751 // Indicates how many consecutive times an ack has arrived which indicates
752 // the peer needs to stop waiting for some packets.
753 int stop_waiting_count_;
755 // An alarm that fires when an ACK should be sent to the peer.
756 scoped_ptr<QuicAlarm> ack_alarm_;
757 // An alarm that fires when a packet needs to be retransmitted.
758 scoped_ptr<QuicAlarm> retransmission_alarm_;
759 // An alarm that is scheduled when the sent scheduler requires a
760 // a delay before sending packets and fires when the packet may be sent.
761 scoped_ptr<QuicAlarm> send_alarm_;
762 // An alarm that is scheduled when the connection can still write and there
763 // may be more data to send.
764 scoped_ptr<QuicAlarm> resume_writes_alarm_;
765 // An alarm that fires when the connection may have timed out.
766 scoped_ptr<QuicAlarm> timeout_alarm_;
767 // An alarm that fires when a ping should be sent.
768 scoped_ptr<QuicAlarm> ping_alarm_;
770 // Neither visitor is owned by this class.
771 QuicConnectionVisitorInterface* visitor_;
772 QuicConnectionDebugVisitor* debug_visitor_;
774 QuicPacketGenerator packet_generator_;
776 // An alarm that fires when an FEC packet should be sent.
777 scoped_ptr<QuicAlarm> fec_alarm_;
779 // Network idle time before we kill of this connection.
780 QuicTime::Delta idle_network_timeout_;
781 // Overall connection timeout.
782 QuicTime::Delta overall_connection_timeout_;
784 // Statistics for this session.
785 QuicConnectionStats stats_;
787 // The time that we got a packet for this connection.
788 // This is used for timeouts, and does not indicate the packet was processed.
789 QuicTime time_of_last_received_packet_;
791 // The last time this connection began sending a new (non-retransmitted)
792 // packet.
793 QuicTime time_of_last_sent_new_packet_;
795 // Sequence number of the last sent packet. Packets are guaranteed to be sent
796 // in sequence number order.
797 QuicPacketSequenceNumber sequence_number_of_last_sent_packet_;
799 // Sent packet manager which tracks the status of packets sent by this
800 // connection and contains the send and receive algorithms to determine when
801 // to send packets.
802 QuicSentPacketManager sent_packet_manager_;
804 // The state of connection in version negotiation finite state machine.
805 QuicVersionNegotiationState version_negotiation_state_;
807 // Tracks if the connection was created by the server.
808 bool is_server_;
810 // True by default. False if we've received or sent an explicit connection
811 // close.
812 bool connected_;
814 // Set to true if the UDP packet headers have a new IP address for the peer.
815 // If true, do not perform connection migration.
816 bool peer_ip_changed_;
818 // Set to true if the UDP packet headers have a new port for the peer.
819 // If true, and the IP has not changed, then we can migrate the connection.
820 bool peer_port_changed_;
822 // Set to true if the UDP packet headers are addressed to a different IP.
823 // We do not support connection migration when the self IP changed.
824 bool self_ip_changed_;
826 // Set to true if the UDP packet headers are addressed to a different port.
827 // We do not support connection migration when the self port changed.
828 bool self_port_changed_;
830 // Set to false if the connection should not send truncated connection IDs to
831 // the peer, even if the peer supports it.
832 bool can_truncate_connection_ids_;
834 // If non-empty this contains the set of versions received in a
835 // version negotiation packet.
836 QuicVersionVector server_supported_versions_;
838 // True if this is a secure QUIC connection.
839 bool is_secure_;
841 DISALLOW_COPY_AND_ASSIGN(QuicConnection);
844 } // namespace net
846 #endif // NET_QUIC_QUIC_CONNECTION_H_