net/tools/quic/quic_server_session.h

   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 // A server specific QuicSession subclass.
   6
   7 #ifndef NET_TOOLS_QUIC_QUIC_SERVER_SESSION_H_
   8 #define NET_TOOLS_QUIC_QUIC_SERVER_SESSION_H_
   9
  10 #include <set>
  11 #include <string>
  12 #include <vector>
  13
  14 #include "base/basictypes.h"
  15 #include "base/containers/hash_tables.h"
  16 #include "base/memory/scoped_ptr.h"
  17 #include "net/quic/quic_crypto_server_stream.h"
  18 #include "net/quic/quic_protocol.h"
  19 #include "net/quic/quic_session.h"
  20
  21 namespace net {
  22
  23 class QuicBlockedWriterInterface;
  24 class QuicConfig;
  25 class QuicConnection;
  26 class QuicCryptoServerConfig;
  27 class ReliableQuicStream;
  28
  29 namespace tools {
  30
  31 namespace test {
  32 class QuicServerSessionPeer;
  33 }  // namespace test
  34
  35 // An interface from the session to the entity owning the session.
  36 // This lets the session notify its owner (the Dispatcher) when the connection
  37 // is closed or blocked.
  38 class QuicServerSessionVisitor {
  39  public:
  40   virtual ~QuicServerSessionVisitor() {}
  41
  42   virtual void OnConnectionClosed(QuicConnectionId connection_id,
  43                                   QuicErrorCode error) = 0;
  44   virtual void OnWriteBlocked(QuicBlockedWriterInterface* blocked_writer) = 0;
  45 };
  46
  47 class QuicServerSession : public QuicSession {
  48  public:
  49   QuicServerSession(const QuicConfig& config,
  50                     QuicConnection* connection,
  51                     QuicServerSessionVisitor* visitor);
  52
  53   // Override the base class to notify the owner of the connection close.
  54   void OnConnectionClosed(QuicErrorCode error, bool from_peer) override;
  55   void OnWriteBlocked() override;
  56
  57   // Sends a server config update to the client, containing new bandwidth
  58   // estimate.
  59   void OnCongestionWindowChange(QuicTime now) override;
  60
  61   ~QuicServerSession() override;
  62
  63   virtual void InitializeSession(const QuicCryptoServerConfig& crypto_config);
  64
  65   const QuicCryptoServerStream* crypto_stream() const {
  66     return crypto_stream_.get();
  67   }
  68
  69   // Override base class to process FEC config received from client.
  70   void OnConfigNegotiated() override;
  71
  72   void set_serving_region(std::string serving_region) {
  73     serving_region_ = serving_region;
  74   }
  75
  76  protected:
  77   // QuicSession methods:
  78   QuicDataStream* CreateIncomingDataStream(QuicStreamId id) override;
  79   QuicDataStream* CreateOutgoingDataStream() override;
  80   QuicCryptoServerStream* GetCryptoStream() override;
  81
  82   // If we should create an incoming stream, returns true. Otherwise
  83   // does error handling, including communicating the error to the client and
  84   // possibly closing the connection, and returns false.
  85   virtual bool ShouldCreateIncomingDataStream(QuicStreamId id);
  86
  87   virtual QuicCryptoServerStream* CreateQuicCryptoServerStream(
  88       const QuicCryptoServerConfig& crypto_config);
  89
  90  private:
  91   friend class test::QuicServerSessionPeer;
  92
  93   scoped_ptr<QuicCryptoServerStream> crypto_stream_;
  94   QuicServerSessionVisitor* visitor_;
  95
  96   // The most recent bandwidth estimate sent to the client.
  97   QuicBandwidth bandwidth_estimate_sent_to_client_;
  98
  99   // Text describing server location. Sent to the client as part of the bandwith
 100   // estimate in the source-address token. Optional, can be left empty.
 101   std::string serving_region_;
 102
 103   // Time at which we send the last SCUP to the client.
 104   QuicTime last_scup_time_;
 105
 106   // Number of packets sent to the peer, at the time we last sent a SCUP.
 107   int64 last_scup_sequence_number_;
 108
 109   DISALLOW_COPY_AND_ASSIGN(QuicServerSession);
 110 };
 111
 112 }  // namespace tools
 113 }  // namespace net
 114
 115 #endif  // NET_TOOLS_QUIC_QUIC_SERVER_SESSION_H_