net/quic/quic_server.h

   1 // Copyright 2014 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 toy server, which listens on a specified address for QUIC traffic and
   6 // handles incoming responses.
   7
   8 #ifndef NET_QUIC_QUIC_SERVER_H_
   9 #define NET_QUIC_QUIC_SERVER_H_
  10
  11 #include "base/basictypes.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "net/base/io_buffer.h"
  14 #include "net/base/ip_endpoint.h"
  15 #include "net/base/net_log.h"
  16 #include "net/quic/crypto/quic_crypto_server_config.h"
  17 #include "net/quic/quic_clock.h"
  18 #include "net/quic/quic_config.h"
  19 #include "net/quic/quic_connection_helper.h"
  20
  21 namespace net {
  22
  23
  24 namespace test {
  25 class QuicServerPeer;
  26 }  // namespace test
  27
  28 class QuicConnectionHelperInterface;
  29 class QuicDispatcher;
  30 class UDPServerSocket;
  31
  32 class QuicServer {
  33  public:
  34   QuicServer(const QuicConfig& config,
  35              const QuicVersionVector& supported_versions);
  36
  37   virtual ~QuicServer();
  38
  39   // Start listening on the specified address. Returns an error code.
  40   int Listen(const IPEndPoint& address);
  41
  42   // Server deletion is imminent. Start cleaning up.
  43   void Shutdown();
  44
  45   // Start reading on the socket. On asynchronous reads, this registers
  46   // OnReadComplete as the callback, which will then call StartReading again.
  47   void StartReading();
  48
  49   // Called on reads that complete asynchronously. Dispatches the packet and
  50   // continues the read loop.
  51   void OnReadComplete(int result);
  52
  53   void SetStrikeRegisterNoStartupPeriod() {
  54     crypto_config_.set_strike_register_no_startup_period();
  55   }
  56
  57   // SetProofSource sets the ProofSource that will be used to verify the
  58   // server's certificate, and takes ownership of |source|.
  59   void SetProofSource(ProofSource* source) {
  60     crypto_config_.SetProofSource(source);
  61   }
  62
  63  private:
  64   friend class net::test::QuicServerPeer;
  65
  66   // Initialize the internal state of the server.
  67   void Initialize();
  68
  69   // Accepts data from the framer and demuxes clients to sessions.
  70   scoped_ptr<QuicDispatcher> dispatcher_;
  71
  72   // Used by the helper_ to time alarms.
  73   QuicClock clock_;
  74
  75   // Used to manage the message loop.
  76   QuicConnectionHelper helper_;
  77
  78   // Listening socket. Also used for outbound client communication.
  79   scoped_ptr<UDPServerSocket> socket_;
  80
  81   // config_ contains non-crypto parameters that are negotiated in the crypto
  82   // handshake.
  83   QuicConfig config_;
  84   // crypto_config_ contains crypto parameters for the handshake.
  85   QuicCryptoServerConfig crypto_config_;
  86
  87   // This vector contains QUIC versions which we currently support.
  88   // This should be ordered such that the highest supported version is the first
  89   // element, with subsequent elements in descending order (versions can be
  90   // skipped as necessary).
  91   QuicVersionVector supported_versions_;
  92
  93   // The address that the server listens on.
  94   IPEndPoint server_address_;
  95
  96   // Keeps track of whether a read is currently in flight, after which
  97   // OnReadComplete will be called.
  98   bool read_pending_;
  99
 100   // The number of iterations of the read loop that have completed synchronously
 101   // and without posting a new task to the message loop.
 102   int synchronous_read_count_;
 103
 104   // The target buffer of the current read.
 105   scoped_refptr<IOBufferWithSize> read_buffer_;
 106
 107   // The source address of the current read.
 108   IPEndPoint client_address_;
 109
 110   // The log to use for the socket.
 111   NetLog net_log_;
 112
 113   base::WeakPtrFactory<QuicServer> weak_factory_;
 114
 115   DISALLOW_COPY_AND_ASSIGN(QuicServer);
 116 };
 117
 118 }  // namespace net
 119
 120 #endif  // NET_QUIC_QUIC_SERVER_H_