net/socket/buffered_write_stream_socket.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 #ifndef NET_SOCKET_BUFFERED_WRITE_STREAM_SOCKET_H_
   6 #define NET_SOCKET_BUFFERED_WRITE_STREAM_SOCKET_H_
   7
   8 #include "base/memory/weak_ptr.h"
   9 #include "net/base/net_log.h"
  10 #include "net/socket/stream_socket.h"
  11
  12 namespace base {
  13 class TimeDelta;
  14 }
  15
  16 namespace net {
  17
  18 class AddressList;
  19 class GrowableIOBuffer;
  20 class IPEndPoint;
  21
  22 // A StreamSocket decorator. All functions are passed through to the wrapped
  23 // socket, except for Write().
  24 //
  25 // Writes are buffered locally so that multiple Write()s to this class are
  26 // issued as only one Write() to the wrapped socket. This is useful to force
  27 // multiple requests to be issued in a single packet, as is needed to trigger
  28 // edge cases in HTTP pipelining.
  29 //
  30 // Note that the Write() always returns synchronously. It will either buffer the
  31 // entire input or return the most recently reported error.
  32 //
  33 // There are no bounds on the local buffer size. Use carefully.
  34 class NET_EXPORT_PRIVATE BufferedWriteStreamSocket : public StreamSocket {
  35  public:
  36   BufferedWriteStreamSocket(StreamSocket* socket_to_wrap);
  37   virtual ~BufferedWriteStreamSocket();
  38
  39   // Socket interface
  40   virtual int Read(IOBuffer* buf, int buf_len,
  41                    const CompletionCallback& callback) OVERRIDE;
  42   virtual int Write(IOBuffer* buf, int buf_len,
  43                     const CompletionCallback& callback) OVERRIDE;
  44   virtual bool SetReceiveBufferSize(int32 size) OVERRIDE;
  45   virtual bool SetSendBufferSize(int32 size) OVERRIDE;
  46
  47   // StreamSocket interface
  48   virtual int Connect(const CompletionCallback& callback) OVERRIDE;
  49   virtual void Disconnect() OVERRIDE;
  50   virtual bool IsConnected() const OVERRIDE;
  51   virtual bool IsConnectedAndIdle() const OVERRIDE;
  52   virtual int GetPeerAddress(IPEndPoint* address) const OVERRIDE;
  53   virtual int GetLocalAddress(IPEndPoint* address) const OVERRIDE;
  54   virtual const BoundNetLog& NetLog() const OVERRIDE;
  55   virtual void SetSubresourceSpeculation() OVERRIDE;
  56   virtual void SetOmniboxSpeculation() OVERRIDE;
  57   virtual bool WasEverUsed() const OVERRIDE;
  58   virtual bool UsingTCPFastOpen() const OVERRIDE;
  59   virtual bool WasNpnNegotiated() const OVERRIDE;
  60   virtual NextProto GetNegotiatedProtocol() const OVERRIDE;
  61   virtual bool GetSSLInfo(SSLInfo* ssl_info) OVERRIDE;
  62
  63  private:
  64   void DoDelayedWrite();
  65   void OnIOComplete(int result);
  66
  67   scoped_ptr<StreamSocket> wrapped_socket_;
  68   scoped_refptr<GrowableIOBuffer> io_buffer_;
  69   scoped_refptr<GrowableIOBuffer> backup_buffer_;
  70   base::WeakPtrFactory<BufferedWriteStreamSocket> weak_factory_;
  71   bool callback_pending_;
  72   bool wrapped_write_in_progress_;
  73   int error_;
  74 };
  75
  76 }  // namespace net
  77
  78 #endif  // NET_SOCKET_STREAM_SOCKET_H_