Chromium Code Reviews| Index: ipc/ipc_message_filter.h |
| diff --git a/ipc/ipc_message_filter.h b/ipc/ipc_message_filter.h |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..84da5c1a06b004596a32f2ced7756727259e8e53 |
| --- /dev/null |
| +++ b/ipc/ipc_message_filter.h |
| @@ -0,0 +1,93 @@ |
| +// Copyright (c) 2014 The Chromium Authors. All rights reserved. |
| +// Use of this source code is governed by a BSD-style license that can be |
| +// found in the LICENSE file. |
| + |
| +#ifndef IPC_IPC_MESSAGE_FILTER_H_ |
| +#define IPC_IPC_MESSAGE_FILTER_H_ |
| + |
| +#include <vector> |
| + |
| +#include "base/memory/ref_counted.h" |
| +#include "ipc/ipc_export.h" |
| +#include "ipc/ipc_message_start.h" |
| + |
| +namespace IPC { |
| + |
| +class Channel; |
| +class Message; |
| + |
| +// A class that receives messages on the thread where the IPC channel is |
| +// running. It can choose to prevent the default action for an IPC message. |
| +class IPC_EXPORT MessageFilter |
| + : public base::RefCountedThreadSafe<MessageFilter> { |
| + public: |
| + MessageFilter(); |
| + |
| + // Called on the background thread to provide the filter with access to the |
| + // channel. Called when the IPC channel is initialized or when AddFilter |
| + // is called if the channel is already initialized. |
| + virtual void OnFilterAdded(Channel* channel); |
| + |
| + // Called on the background thread when the filter has been removed from |
| + // the ChannelProxy and when the Channel is closing. After a filter is |
| + // removed, it will not be called again. |
| + virtual void OnFilterRemoved(); |
| + |
| + // Called to inform the filter that the IPC channel is connected and we |
| + // have received the internal Hello message from the peer. |
| + virtual void OnChannelConnected(int32 peer_pid); |
| + |
| + // Called when there is an error on the channel, typically that the channel |
| + // has been closed. |
| + virtual void OnChannelError(); |
| + |
| + // Called to inform the filter that the IPC channel will be destroyed. |
| + // OnFilterRemoved is called immediately after this. |
| + virtual void OnChannelClosing(); |
| + |
| + // Return true to indicate that the message was handled, or false to let |
| + // the message be handled in the default way. |
| + virtual bool OnMessageReceived(const Message& message); |
| + |
| + // Called to query the Message classes supported by the filter. Return |
| + // false to indicate that all message types should reach the filter, or true |
| + // if the resulting contents of |supported_message_classes| may be used to |
| + // selectively offer messages of a particular class to the filter. |
| + virtual bool GetSupportedMessageClasses( |
| + std::vector<uint32>* supported_message_classes) const; |
| + |
| + protected: |
| + virtual ~MessageFilter(); |
| + |
| + private: |
| + friend class base::RefCountedThreadSafe<MessageFilter>; |
| +}; |
| + |
| +//------------------------------------------------------------------------------ |
| + |
| +class MessageFilterRouter { |
|
jam
2014/04/22 17:14:27
put this in a separate file
dmichael (off chromium)
2014/04/23 19:42:31
Done.
|
| + public: |
| + typedef std::vector<MessageFilter*> MessageFilters; |
| + |
| + MessageFilterRouter(); |
| + ~MessageFilterRouter(); |
| + |
| + void AddFilter(MessageFilter* filter); |
| + void RemoveFilter(MessageFilter* filter); |
| + bool TryFilters(const Message& message); |
| + void Clear(); |
| + |
| + private: |
| + // List of global and selective filters; a given filter will exist in either |
| + // |message_global_filters_| OR |message_class_filters_|, but not both. |
| + // Note that |message_global_filters_| will be given first offering of any |
| + // given message. It's the filter implementer and installer's |
| + // responsibility to ensure that a filter is either global or selective to |
| + // ensure proper message filtering order. |
| + MessageFilters global_filters_; |
| + MessageFilters message_class_filters_[LastIPCMsgStart]; |
| +}; |
| + |
| +} // namespace IPC |
| + |
| +#endif // IPC_IPC_MESSAGE_FILTER_H_ |