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, blocked, or added/removed from the time-wait list.
  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   // Called after the given connection is added to the time-wait list.
  46   virtual void OnConnectionAddedToTimeWaitList(QuicConnectionId connection_id) {
  47   }
  48   // Called after the given connection is removed from the time-wait list.
  49   virtual void OnConnectionRemovedFromTimeWaitList(
  50       QuicConnectionId connection_id) {}
  51 };
  52
  53 class QuicServerSession : public QuicSession {
  54  public:
  55   QuicServerSession(const QuicConfig& config,
  56                     QuicConnection* connection,
  57                     QuicServerSessionVisitor* visitor);
  58
  59   // Override the base class to notify the owner of the connection close.
  60   void OnConnectionClosed(QuicErrorCode error, bool from_peer) override;
  61   void OnWriteBlocked() override;
  62
  63   // Sends a server config update to the client, containing new bandwidth
  64   // estimate.
  65   void OnCongestionWindowChange(QuicTime now) override;
  66
  67   ~QuicServerSession() override;
  68
  69   // |crypto_config| must outlive the session.
  70   virtual void InitializeSession(const QuicCryptoServerConfig* crypto_config);
  71
  72   const QuicCryptoServerStream* crypto_stream() const {
  73     return crypto_stream_.get();
  74   }
  75
  76   // Override base class to process FEC config received from client.
  77   void OnConfigNegotiated() override;
  78
  79   void set_serving_region(std::string serving_region) {
  80     serving_region_ = serving_region;
  81   }
  82
  83  protected:
  84   // QuicSession methods:
  85   QuicDataStream* CreateIncomingDataStream(QuicStreamId id) override;
  86   QuicDataStream* CreateOutgoingDataStream() override;
  87   QuicCryptoServerStream* GetCryptoStream() override;
  88
  89   // If we should create an incoming stream, returns true. Otherwise
  90   // does error handling, including communicating the error to the client and
  91   // possibly closing the connection, and returns false.
  92   virtual bool ShouldCreateIncomingDataStream(QuicStreamId id);
  93
  94   virtual QuicCryptoServerStream* CreateQuicCryptoServerStream(
  95       const QuicCryptoServerConfig* crypto_config);
  96
  97  private:
  98   friend class test::QuicServerSessionPeer;
  99
 100   scoped_ptr<QuicCryptoServerStream> crypto_stream_;
 101   QuicServerSessionVisitor* visitor_;
 102
 103   // The most recent bandwidth estimate sent to the client.
 104   QuicBandwidth bandwidth_estimate_sent_to_client_;
 105
 106   // Text describing server location. Sent to the client as part of the bandwith
 107   // estimate in the source-address token. Optional, can be left empty.
 108   std::string serving_region_;
 109
 110   // Time at which we send the last SCUP to the client.
 111   QuicTime last_scup_time_;
 112
 113   // Number of packets sent to the peer, at the time we last sent a SCUP.
 114   int64 last_scup_sequence_number_;
 115
 116   DISALLOW_COPY_AND_ASSIGN(QuicServerSession);
 117 };
 118
 119 }  // namespace tools
 120 }  // namespace net
 121
 122 #endif  // NET_TOOLS_QUIC_QUIC_SERVER_SESSION_H_