brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 1 | // Copyright (c) 2011 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_TEST_SINK_H_ |
| 6 | #define IPC_IPC_TEST_SINK_H_ |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 7 | |
| 8 | #include <utility> |
| 9 | #include <vector> |
| 10 | |
| 11 | #include "base/basictypes.h" |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 12 | #include "base/observer_list.h" |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 13 | #include "ipc/ipc_channel.h" |
| 14 | |
| 15 | namespace IPC { |
| 16 | |
| 17 | class Message; |
| 18 | |
| 19 | // This test sink provides a "sink" for IPC messages that are sent. It allows |
| 20 | // the caller to query messages received in various different ways. It is |
| 21 | // designed for tests for objects that use the IPC system. |
| 22 | // |
| 23 | // Typical usage: |
| 24 | // |
| 25 | // test_sink.ClearMessages(); |
| 26 | // do_something(); |
| 27 | // |
| 28 | // // We should have gotten exactly one update state message. |
| 29 | // EXPECT_TRUE(test_sink.GetUniqeMessageMatching(ViewHostMsg_Update::ID)); |
| 30 | // // ...and no start load messages. |
| 31 | // EXPECT_FALSE(test_sink.GetFirstMessageMatching(ViewHostMsg_Start::ID)); |
| 32 | // |
| 33 | // // Now inspect a message. This assumes a message that was declared like |
| 34 | // // this: IPC_MESSAGE_ROUTED2(ViewMsg_Foo, bool, int) |
| 35 | // IPC::Message* msg = test_sink.GetFirstMessageMatching(ViewMsg_Foo::ID)); |
| 36 | // ASSERT_TRUE(msg); |
| 37 | // bool first_param; |
| 38 | // int second_param; |
| 39 | // ViewMsg_Foo::Read(msg, &first_param, &second_param); |
| 40 | // |
| 41 | // // Go on to the next phase of the test. |
| 42 | // test_sink.ClearMessages(); |
| 43 | // |
brettw@chromium.org | ccb3fef | 2011-02-09 01:31:46 +0900 | [diff] [blame] | 44 | // To read a sync reply, do this: |
| 45 | // |
| 46 | // IPC::Message* msg = test_sink.GetUniqueMessageMatching(IPC_REPLY_ID); |
| 47 | // ASSERT_TRUE(msg); |
jam@chromium.org | cbc95ec | 2011-03-16 02:16:55 +0900 | [diff] [blame] | 48 | // TupleTypes<ViewHostMsg_Foo::ReplyParam>::ValueTuple reply_data; |
brettw@chromium.org | ccb3fef | 2011-02-09 01:31:46 +0900 | [diff] [blame] | 49 | // EXPECT_TRUE(ViewHostMsg_Foo::ReadReplyParam(msg, &reply_data)); |
| 50 | // |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 51 | // You can also register to be notified when messages are posted to the sink. |
| 52 | // This can be useful if you need to wait for a particular message that will |
| 53 | // be posted asynchronously. Example usage: |
| 54 | // |
brettw@chromium.org | db1259e | 2012-06-30 07:05:26 +0900 | [diff] [blame] | 55 | // class MyListener : public IPC::Listener { |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 56 | // public: |
| 57 | // virtual bool OnMessageReceived(const IPC::Message& msg) { |
| 58 | // <do something with the message> |
| 59 | // MessageLoop::current()->Quit(); |
| 60 | // return false; // to store the message in the sink, or true to drop it |
| 61 | // } |
| 62 | // }; |
| 63 | // |
| 64 | // MyListener listener; |
| 65 | // test_sink.AddFilter(&listener); |
| 66 | // StartSomeAsynchronousProcess(&test_sink); |
| 67 | // MessageLoop::current()->Run(); |
| 68 | // <inspect the results> |
| 69 | // ... |
| 70 | // |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 71 | // To hook up the sink, all you need to do is call OnMessageReceived when a |
| 72 | // message is received. |
dmazzoni@chromium.org | 0dc2c0c | 2013-04-13 04:35:35 +0900 | [diff] [blame] | 73 | class TestSink : public Channel { |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 74 | public: |
| 75 | TestSink(); |
hans@chromium.org | 78b7593 | 2011-05-25 18:08:19 +0900 | [diff] [blame] | 76 | virtual ~TestSink(); |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 77 | |
| 78 | // Interface in IPC::Channel. This copies the message to the sink and then |
| 79 | // deletes it. |
avi@chromium.org | 362c8a8 | 2011-11-18 01:09:44 +0900 | [diff] [blame] | 80 | virtual bool Send(IPC::Message* message) OVERRIDE; |
ch.dumez@samsung.com | bbcb44c | 2014-06-10 23:38:39 +0900 | [diff] [blame] | 81 | virtual bool Connect() OVERRIDE WARN_UNUSED_RESULT; |
morrita@chromium.org | fde2b6b | 2014-06-07 05:13:51 +0900 | [diff] [blame] | 82 | virtual void Close() OVERRIDE; |
| 83 | virtual base::ProcessId GetPeerPID() const OVERRIDE; |
morrita@chromium.org | 15996aa | 2014-08-05 08:44:17 +0900 | [diff] [blame] | 84 | virtual base::ProcessId GetSelfPID() const OVERRIDE; |
| 85 | virtual ChannelHandle TakePipeHandle() OVERRIDE; |
morrita@chromium.org | fde2b6b | 2014-06-07 05:13:51 +0900 | [diff] [blame] | 86 | |
| 87 | #if defined(OS_POSIX) && !defined(OS_NACL) |
| 88 | virtual int GetClientFileDescriptor() const OVERRIDE; |
| 89 | virtual int TakeClientFileDescriptor() OVERRIDE; |
morrita@chromium.org | fde2b6b | 2014-06-07 05:13:51 +0900 | [diff] [blame] | 90 | #endif // defined(OS_POSIX) && !defined(OS_NACL) |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 91 | |
| 92 | // Used by the source of the messages to send the message to the sink. This |
| 93 | // will make a copy of the message and store it in the list. |
dmazzoni@chromium.org | 0dc2c0c | 2013-04-13 04:35:35 +0900 | [diff] [blame] | 94 | bool OnMessageReceived(const Message& msg); |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 95 | |
| 96 | // Returns the number of messages in the queue. |
| 97 | size_t message_count() const { return messages_.size(); } |
| 98 | |
| 99 | // Clears the message queue of saved messages. |
| 100 | void ClearMessages(); |
| 101 | |
| 102 | // Returns the message at the given index in the queue. The index may be out |
| 103 | // of range, in which case the return value is NULL. The returned pointer will |
| 104 | // only be valid until another message is received or the list is cleared. |
| 105 | const Message* GetMessageAt(size_t index) const; |
| 106 | |
| 107 | // Returns the first message with the given ID in the queue. If there is no |
| 108 | // message with the given ID, returns NULL. The returned pointer will only be |
| 109 | // valid until another message is received or the list is cleared. |
| 110 | const Message* GetFirstMessageMatching(uint32 id) const; |
| 111 | |
| 112 | // Returns the message with the given ID in the queue. If there is no such |
| 113 | // message or there is more than one of that message, this will return NULL |
| 114 | // (with the expectation that you'll do an ASSERT_TRUE() on the result). |
| 115 | // The returned pointer will only be valid until another message is received |
| 116 | // or the list is cleared. |
| 117 | const Message* GetUniqueMessageMatching(uint32 id) const; |
| 118 | |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 119 | // Adds the given listener as a filter to the TestSink. |
| 120 | // When a message is received by the TestSink, it will be dispatched to |
| 121 | // the filters, in the order they were added. If a filter returns true |
| 122 | // from OnMessageReceived, subsequent filters will not receive the message |
| 123 | // and the TestSink will not store it. |
brettw@chromium.org | db1259e | 2012-06-30 07:05:26 +0900 | [diff] [blame] | 124 | void AddFilter(Listener* filter); |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 125 | |
| 126 | // Removes the given filter from the TestSink. |
brettw@chromium.org | db1259e | 2012-06-30 07:05:26 +0900 | [diff] [blame] | 127 | void RemoveFilter(Listener* filter); |
bryner@chromium.org | 44ae58f | 2011-02-01 06:43:31 +0900 | [diff] [blame] | 128 | |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 129 | private: |
| 130 | // The actual list of received messages. |
| 131 | std::vector<Message> messages_; |
brettw@chromium.org | db1259e | 2012-06-30 07:05:26 +0900 | [diff] [blame] | 132 | ObserverList<Listener> filter_list_; |
brettw@google.com | c0f8558 | 2011-01-21 08:50:27 +0900 | [diff] [blame] | 133 | |
| 134 | DISALLOW_COPY_AND_ASSIGN(TestSink); |
| 135 | }; |
| 136 | |
| 137 | } // namespace IPC |
| 138 | |
| 139 | #endif // IPC_IPC_TEST_SINK_H_ |