reliable_quic_stream.h revision 868fa2fe829687343ffae624259930155e16dbd8
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The base class for client/server reliable streams. 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_QUIC_RELIABLE_QUIC_STREAM_H_ 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_QUIC_RELIABLE_QUIC_STREAM_H_ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include <sys/types.h> 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include <list> 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 14b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "base/strings/string_piece.h" 15b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "net/base/iovec.h" 16b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "net/base/net_export.h" 1790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "net/quic/quic_spdy_compressor.h" 18b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "net/quic/quic_spdy_decompressor.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/quic/quic_stream_sequencer.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace test { 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class ReliableQuicStreamPeer; 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace test 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class IPEndPoint; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class QuicSession; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All this does right now is send data to subclasses via the sequencer. 31b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)class NET_EXPORT_PRIVATE ReliableQuicStream : public 32b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicSpdyDecompressor::Visitor { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Visitor receives callbacks from the stream. 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) class Visitor { 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor() {} 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when the stream is closed. 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnClose(ReliableQuicStream* stream) = 0; 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) protected: 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~Visitor() {} 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) private: 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Visitor); 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) }; 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ReliableQuicStream(QuicStreamId id, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ReliableQuicStream(); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool WillAcceptStreamFrame(const QuicStreamFrame& frame) const; 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool OnStreamFrame(const QuicStreamFrame& frame); 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnCanWrite(); 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called by the session just before the stream is deleted. 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnClose(); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when we get a stream reset from the client. 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnStreamReset(QuicRstStreamErrorCode error); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when we get or send a connection close, and should immediately 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // close the stream. This is not passed through the sequencer, 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but is handled immediately. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ConnectionClose(QuicErrorCode error, bool from_peer); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the sequencer, when we should process a stream termination or 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // stream close from the peer. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void TerminateFromPeer(bool half_close); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 74b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual uint32 ProcessRawData(const char* data, uint32 data_len); 75b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual uint32 ProcessHeaderData(); 76b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual uint32 ProcessData(const char* data, uint32 data_len) = 0; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 79b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual bool OnDecompressedData(base::StringPiece data) OVERRIDE; 8090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void OnDecompressionError() OVERRIDE; 81b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called to close the stream from this end. 83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void Close(QuicRstStreamErrorCode error); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This block of functions wraps the sequencer's functions of the same 86b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // name. These methods return uncompressed data until that has 87b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // been fully processed. Then they simply delegate to the sequencer. 88868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) virtual int Readv(const struct iovec* iov, size_t iov_len); 89868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) virtual int GetReadableRegions(iovec* iov, size_t iov_len); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsHalfClosed() const; 91c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool IsClosed() const; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool HasBytesToRead() const; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 94b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Called by the session when a decompression blocked stream 95b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // becomes unblocked. 96b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual void OnDecompressorAvailable(); 97b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamId id() const { return id_; } 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 100c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicRstStreamErrorCode stream_error() const { return stream_error_; } 101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicErrorCode connection_error() const { return connection_error_; } 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool read_side_closed() const { return read_side_closed_; } 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool write_side_closed() const { return write_side_closed_; } 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 106b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) uint64 stream_bytes_read() { return stream_bytes_read_; } 107b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) uint64 stream_bytes_written() { return stream_bytes_written_; } 108b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const IPEndPoint& GetPeerAddress() const; 1102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor* visitor() { return visitor_; } 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void set_visitor(Visitor* visitor) { visitor_ = visitor; } 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 11490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) QuicSpdyCompressor* compressor(); 11590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a pair with the number of bytes consumed from data, and a boolean 1182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // indicating if the fin bit was consumed. This does not indicate the data 1192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // has been sent on the wire: it may have been turned into a packet and queued 1202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // if the socket was unexpectedly blocked. 1212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 1222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The default implementation always consumed all bytes and any fin, but 1232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // this behavior is not guaranteed for subclasses so callers should check the 1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // return value. 1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual QuicConsumedData WriteData(base::StringPiece data, bool fin); 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Close the read side of the socket. Further frames will not be accepted. 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CloseReadSide(); 1292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Close the write side of the socket. Further writes will fail. 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseWriteSide(); 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 133b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) bool fin_buffered() { return fin_buffered_; } 134b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session() { return session_; } 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends as much of 'data' to the connection as the connection will consume, 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and then buffers any remaining data in queued_data_. 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns (data.size(), true) as it always consumed all data: it returns for 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // convenience to have the same return type as WriteDataInternal. 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicConsumedData WriteOrBuffer(base::StringPiece data, bool fin); 1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends as much of 'data' to the connection as the connection will consume. 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the number of bytes consumed by the connection. 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicConsumedData WriteDataInternal(base::StringPiece data, bool fin); 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class test::ReliableQuicStreamPeer; 1492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class QuicStreamUtils; 1502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::list<string> queued_data_; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamSequencer sequencer_; 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamId id_; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session_; 1562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Optional visitor of this stream to be notified when the stream is closed. 1572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor* visitor_; 1582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Bytes read and written refer to payload bytes only: they do not include 1592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // framing, encryption overhead etc. 1602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint64 stream_bytes_read_; 1612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint64 stream_bytes_written_; 162b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // True if the headers have been completely decompresssed. 163b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) bool headers_decompressed_; 164b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // ID of the header block sent by the peer, once parsed. 165b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicHeaderId headers_id_; 166b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Buffer into which we write bytes from the headers_id_ 167b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // until it is fully parsed. 168b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) string headers_id_buffer_; 169b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Contains a copy of the decompressed headers_ until they are consumed 170b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // via ProcessData or Readv. 171b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) string decompressed_headers_; 172c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 173c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Stream error code received from a RstStreamFrame or error code sent by the 174c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // visitor or sequencer in the RstStreamFrame. 175c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicRstStreamErrorCode stream_error_; 176c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Connection error code due to which the stream was closed. |stream_error_| 177c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // is set to |QUIC_STREAM_CONNECTION_ERROR| when this happens and consumers 178c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // should check |connection_error_|. 179c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicErrorCode connection_error_; 180c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if the read side is closed and further frames should be rejected. 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool read_side_closed_; 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if the write side is closed, and further writes should fail. 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool write_side_closed_; 1852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool fin_buffered_; 1872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool fin_sent_; 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_QUIC_RELIABLE_QUIC_STREAM_H_ 193