reliable_quic_stream.h revision b2df76ea8fec9e32f6f3718986dba0d95315b29c
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" 17b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)#include "net/quic/quic_spdy_decompressor.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/quic/quic_stream_sequencer.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace test { 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class ReliableQuicStreamPeer; 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace test 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class IPEndPoint; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class QuicSession; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All this does right now is send data to subclasses via the sequencer. 30b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)class NET_EXPORT_PRIVATE ReliableQuicStream : public 31b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicSpdyDecompressor::Visitor { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Visitor receives callbacks from the stream. 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) class Visitor { 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor() {} 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when the stream is closed. 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnClose(ReliableQuicStream* stream) = 0; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) protected: 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~Visitor() {} 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) private: 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Visitor); 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) }; 472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ReliableQuicStream(QuicStreamId id, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ReliableQuicStream(); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool WillAcceptStreamFrame(const QuicStreamFrame& frame) const; 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool OnStreamFrame(const QuicStreamFrame& frame); 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnCanWrite(); 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called by the session just before the stream is deleted. 592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnClose(); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when we get a stream reset from the client. 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnStreamReset(QuicRstStreamErrorCode error); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when we get or send a connection close, and should immediately 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // close the stream. This is not passed through the sequencer, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // but is handled immediately. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ConnectionClose(QuicErrorCode error, bool from_peer); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the sequencer, when we should process a stream termination or 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // stream close from the peer. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void TerminateFromPeer(bool half_close); 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 73b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual uint32 ProcessRawData(const char* data, uint32 data_len); 74b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual uint32 ProcessHeaderData(); 75b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual uint32 ProcessData(const char* data, uint32 data_len) = 0; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 78b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual bool OnDecompressedData(base::StringPiece data) OVERRIDE; 79b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called to close the stream from this end. 81c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void Close(QuicRstStreamErrorCode error); 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This block of functions wraps the sequencer's functions of the same 84b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // name. These methods return uncompressed data until that has 85b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // been fully processed. Then they simply delegate to the sequencer. 86b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual int Readv(const struct iovec* iov, int iov_len); 87b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual int GetReadableRegions(iovec* iov, int iov_len); 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsHalfClosed() const; 89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool IsClosed() const; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool HasBytesToRead() const; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 92b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Called by the session when a decompression blocked stream 93b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // becomes unblocked. 94b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual void OnDecompressorAvailable(); 95b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamId id() const { return id_; } 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 98c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicRstStreamErrorCode stream_error() const { return stream_error_; } 99c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicErrorCode connection_error() const { return connection_error_; } 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool read_side_closed() const { return read_side_closed_; } 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool write_side_closed() const { return write_side_closed_; } 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 104b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) uint64 stream_bytes_read() { return stream_bytes_read_; } 105b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) uint64 stream_bytes_written() { return stream_bytes_written_; } 106b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 1072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const IPEndPoint& GetPeerAddress() const; 1082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor* visitor() { return visitor_; } 1102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void set_visitor(Visitor* visitor) { visitor_ = visitor; } 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a pair with the number of bytes consumed from data, and a boolean 1142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // indicating if the fin bit was consumed. This does not indicate the data 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // has been sent on the wire: it may have been turned into a packet and queued 1162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // if the socket was unexpectedly blocked. 1172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 1182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The default implementation always consumed all bytes and any fin, but 1192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // this behavior is not guaranteed for subclasses so callers should check the 1202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // return value. 1212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual QuicConsumedData WriteData(base::StringPiece data, bool fin); 1222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Close the read side of the socket. Further frames will not be accepted. 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CloseReadSide(); 1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Close the write side of the socket. Further writes will fail. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseWriteSide(); 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 129b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) bool fin_buffered() { return fin_buffered_; } 130b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session() { return session_; } 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends as much of 'data' to the connection as the connection will consume, 1342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and then buffers any remaining data in queued_data_. 1352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns (data.size(), true) as it always consumed all data: it returns for 1362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // convenience to have the same return type as WriteDataInternal. 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicConsumedData WriteOrBuffer(base::StringPiece data, bool fin); 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Sends as much of 'data' to the connection as the connection will consume. 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the number of bytes consumed by the connection. 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicConsumedData WriteDataInternal(base::StringPiece data, bool fin); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class test::ReliableQuicStreamPeer; 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class QuicStreamUtils; 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::list<string> queued_data_; 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamSequencer sequencer_; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicStreamId id_; 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicSession* session_; 1522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Optional visitor of this stream to be notified when the stream is closed. 1532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) Visitor* visitor_; 1542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Bytes read and written refer to payload bytes only: they do not include 1552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // framing, encryption overhead etc. 1562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint64 stream_bytes_read_; 1572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint64 stream_bytes_written_; 158b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // True if the headers have been completely decompresssed. 159b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) bool headers_decompressed_; 160b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // ID of the header block sent by the peer, once parsed. 161b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicHeaderId headers_id_; 162b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Buffer into which we write bytes from the headers_id_ 163b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // until it is fully parsed. 164b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) string headers_id_buffer_; 165b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Contains a copy of the decompressed headers_ until they are consumed 166b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // via ProcessData or Readv. 167b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) string decompressed_headers_; 168c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 169c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Stream error code received from a RstStreamFrame or error code sent by the 170c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // visitor or sequencer in the RstStreamFrame. 171c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicRstStreamErrorCode stream_error_; 172c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Connection error code due to which the stream was closed. |stream_error_| 173c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // is set to |QUIC_STREAM_CONNECTION_ERROR| when this happens and consumers 174c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // should check |connection_error_|. 175c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicErrorCode connection_error_; 176c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if the read side is closed and further frames should be rejected. 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool read_side_closed_; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if the write side is closed, and further writes should fail. 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool write_side_closed_; 1812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool fin_buffered_; 1832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool fin_sent_; 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_QUIC_RELIABLE_QUIC_STREAM_H_ 189