ipc/ipc_channel_win.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 IPC_IPC_CHANNEL_WIN_H_
   6 #define IPC_IPC_CHANNEL_WIN_H_
   7
   8 #include "ipc/ipc_channel.h"
   9
  10 #include <queue>
  11 #include <string>
  12
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/message_loop/message_loop.h"
  16 #include "base/win/scoped_handle.h"
  17 #include "ipc/ipc_channel_reader.h"
  18
  19 namespace base {
  20 class ThreadChecker;
  21 }
  22
  23 namespace IPC {
  24
  25 class ChannelWin : public Channel,
  26                    public internal::ChannelReader,
  27                    public base::MessageLoopForIO::IOHandler {
  28  public:
  29   // Mirror methods of Channel, see ipc_channel.h for description.
  30   // |broker| must outlive the newly created object.
  31   ChannelWin(const IPC::ChannelHandle& channel_handle,
  32              Mode mode,
  33              Listener* listener,
  34              AttachmentBroker* broker);
  35   ~ChannelWin() override;
  36
  37   // Channel implementation
  38   bool Connect() override;
  39   void Close() override;
  40   bool Send(Message* message) override;
  41   AttachmentBroker* GetAttachmentBroker() override;
  42   base::ProcessId GetPeerPID() const override;
  43   base::ProcessId GetSelfPID() const override;
  44
  45   static bool IsNamedServerInitialized(const std::string& channel_id);
  46
  47
  48  private:
  49   // ChannelReader implementation.
  50   ReadState ReadData(char* buffer, int buffer_len, int* bytes_read) override;
  51   bool WillDispatchInputMessage(Message* msg) override;
  52   bool DidEmptyInputBuffers() override;
  53   void HandleInternalMessage(const Message& msg) override;
  54
  55   static const base::string16 PipeName(const std::string& channel_id,
  56                                        int32* secret);
  57   bool CreatePipe(const IPC::ChannelHandle &channel_handle, Mode mode);
  58
  59   bool ProcessConnection();
  60   bool ProcessOutgoingMessages(base::MessageLoopForIO::IOContext* context,
  61                                DWORD bytes_written);
  62
  63   // MessageLoop::IOHandler implementation.
  64   void OnIOCompleted(base::MessageLoopForIO::IOContext* context,
  65                      DWORD bytes_transfered,
  66                      DWORD error) override;
  67
  68  private:
  69   struct State {
  70     explicit State(ChannelWin* channel);
  71     ~State();
  72     base::MessageLoopForIO::IOContext context;
  73     bool is_pending;
  74   };
  75
  76   State input_state_;
  77   State output_state_;
  78
  79   base::win::ScopedHandle pipe_;
  80
  81   base::ProcessId peer_pid_;
  82
  83   // Messages to be sent are queued here.
  84   std::queue<Message*> output_queue_;
  85
  86   // In server-mode, we have to wait for the client to connect before we
  87   // can begin reading.  We make use of the input_state_ when performing
  88   // the connect operation in overlapped mode.
  89   bool waiting_connect_;
  90
  91   // This flag is set when processing incoming messages.  It is used to
  92   // avoid recursing through ProcessIncomingMessages, which could cause
  93   // problems.  TODO(darin): make this unnecessary
  94   bool processing_incoming_;
  95
  96   // Determines if we should validate a client's secret on connection.
  97   bool validate_client_;
  98
  99   // Tracks the lifetime of this object, for debugging purposes.
 100   uint32 debug_flags_;
 101
 102   // This is a unique per-channel value used to authenticate the client end of
 103   // a connection. If the value is non-zero, the client passes it in the hello
 104   // and the host validates. (We don't send the zero value fto preserve IPC
 105   // compatability with existing clients that don't validate the channel.)
 106   int32 client_secret_;
 107
 108   scoped_ptr<base::ThreadChecker> thread_check_;
 109
 110   // |broker_| must outlive this instance.
 111   AttachmentBroker* broker_;
 112
 113   base::WeakPtrFactory<ChannelWin> weak_factory_;
 114   DISALLOW_COPY_AND_ASSIGN(ChannelWin);
 115 };
 116
 117 }  // namespace IPC
 118
 119 #endif  // IPC_IPC_CHANNEL_WIN_H_