remoting/protocol/fake_datagram_socket.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 #ifndef REMOTING_PROTOCOL_FAKE_DATAGRAM_SOCKET_H_
   6 #define REMOTING_PROTOCOL_FAKE_DATAGRAM_SOCKET_H_
   7
   8 #include <map>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "net/base/completion_callback.h"
  15 #include "net/socket/socket.h"
  16 #include "remoting/protocol/datagram_channel_factory.h"
  17
  18 namespace base {
  19 class SingleThreadTaskRunner;
  20 }
  21
  22 namespace remoting {
  23 namespace protocol {
  24
  25 // FakeDatagramSocket implement net::StreamSocket interface. All data written to
  26 // FakeDatagramSocket is stored in a buffer returned by written_packets().
  27 // Read() reads data from another buffer that can be set with
  28 // AppendInputPacket(). Pending reads are supported, so if there is a pending
  29 // read AppendInputPacket() calls the read callback.
  30 //
  31 // Two fake sockets can be connected to each other using the
  32 // PairWith() method, e.g.: a->PairWith(b). After this all data
  33 // written to |a| can be read from |b| and vice versa. Two connected
  34 // sockets |a| and |b| must be created and used on the same thread.
  35 class FakeDatagramSocket : public net::Socket {
  36  public:
  37   FakeDatagramSocket();
  38   ~FakeDatagramSocket() override;
  39
  40   const std::vector<std::string>& written_packets() const {
  41     return written_packets_;
  42   }
  43
  44   void AppendInputPacket(const std::string& data);
  45
  46   // Current position in the input in number of packets, i.e. number of finished
  47   // Read() calls.
  48   int input_pos() const { return input_pos_; }
  49
  50   // Pairs the socket with |peer_socket|. Deleting either of the paired sockets
  51   // unpairs them.
  52   void PairWith(FakeDatagramSocket* peer_socket);
  53
  54   base::WeakPtr<FakeDatagramSocket> GetWeakPtr();
  55
  56   // net::Socket implementation.
  57   int Read(net::IOBuffer* buf,
  58            int buf_len,
  59            const net::CompletionCallback& callback) override;
  60   int Write(net::IOBuffer* buf,
  61             int buf_len,
  62             const net::CompletionCallback& callback) override;
  63   int SetReceiveBufferSize(int32 size) override;
  64   int SetSendBufferSize(int32 size) override;
  65
  66  private:
  67   int CopyReadData(net::IOBuffer* buf, int buf_len);
  68
  69   base::WeakPtr<FakeDatagramSocket> peer_socket_;
  70
  71   scoped_refptr<net::IOBuffer> read_buffer_;
  72   int read_buffer_size_;
  73   net::CompletionCallback read_callback_;
  74
  75   std::vector<std::string> written_packets_;
  76   std::vector<std::string> input_packets_;
  77   int input_pos_;
  78
  79   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
  80   base::WeakPtrFactory<FakeDatagramSocket> weak_factory_;
  81
  82   DISALLOW_COPY_AND_ASSIGN(FakeDatagramSocket);
  83 };
  84
  85 class FakeDatagramChannelFactory : public DatagramChannelFactory {
  86  public:
  87   FakeDatagramChannelFactory();
  88   ~FakeDatagramChannelFactory() override;
  89
  90   void set_asynchronous_create(bool asynchronous_create) {
  91     asynchronous_create_ = asynchronous_create;
  92   }
  93
  94   void set_fail_create(bool fail_create) { fail_create_ = fail_create; }
  95
  96   // Pair with |peer_factory|. Once paired the factory will be automatically
  97   // pairing created sockets with the sockets with the same name from the peer
  98   // factory.
  99   void PairWith(FakeDatagramChannelFactory* peer_factory);
 100
 101   // Can be used to retrieve FakeDatagramSocket created by this factory, e.g. to
 102   // feed data into it. The caller doesn't get ownership of the result. Returns
 103   // nullptr if the socket doesn't exist.
 104   FakeDatagramSocket* GetFakeChannel(const std::string& name);
 105
 106   // DatagramChannelFactory interface.
 107   void CreateChannel(const std::string& name,
 108                      const ChannelCreatedCallback& callback) override;
 109   void CancelChannelCreation(const std::string& name) override;
 110
 111  private:
 112   typedef std::map<std::string, base::WeakPtr<FakeDatagramSocket> > ChannelsMap;
 113
 114   void NotifyChannelCreated(scoped_ptr<FakeDatagramSocket> owned_socket,
 115                             const std::string& name,
 116                             const ChannelCreatedCallback& callback);
 117
 118   base::WeakPtr<FakeDatagramChannelFactory> peer_factory_;
 119
 120   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
 121   bool asynchronous_create_;
 122   ChannelsMap channels_;
 123
 124   bool fail_create_;
 125
 126   base::WeakPtrFactory<FakeDatagramChannelFactory> weak_factory_;
 127
 128   DISALLOW_COPY_AND_ASSIGN(FakeDatagramChannelFactory);
 129 };
 130
 131 }  // namespace protocol
 132 }  // namespace remoting
 133
 134 #endif  // REMOTING_PROTOCOL_FAKE_DATAGRAM_SOCKET_H_