15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef IPC_IPC_FORWARDING_MESSAGE_FILTER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define IPC_IPC_FORWARDING_MESSAGE_FILTER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/bind.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/callback_forward.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/synchronization/lock.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/task_runner.h" 155c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu#include "ipc/message_filter.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace IPC { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class can be used to intercept routed messages and 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// deliver them to a different task runner than they would otherwise 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// be sent. Messages are filtered based on type. To route these messages, 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// add a MessageRouter to the handler. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The user of this class implements ForwardingMessageFilter::Client, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// which will receive the intercepted messages, on the specified target thread. 265c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liuclass IPC_EXPORT ForwardingMessageFilter : public MessageFilter { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The handler is invoked on the thread associated with 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |target_task_runner| with messages that were intercepted by this filter. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef base::Callback<void(const Message&)> Handler; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This filter will intercept |message_ids_to_filter| and post 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // them to the provided |target_task_runner|, where they will be given 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to |handler|. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The caller must ensure that |handler| outlives the lifetime of the filter. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ForwardingMessageFilter( 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint32* message_ids_to_filter, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t num_message_ids_to_filter, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TaskRunner* target_task_runner); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Define the message routes to be filtered. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddRoute(int routing_id, const Handler& handler); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveRoute(int routing_id); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // MessageFilter methods: 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnMessageReceived(const Message& message) OVERRIDE; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ForwardingMessageFilter(); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<int> message_ids_to_filter_; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The handler_ only gets Run on the thread corresponding to 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // target_task_runner_. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<base::TaskRunner> target_task_runner_; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Protects access to routes_. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Lock handlers_lock_; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Indicates the routing_ids for which messages should be filtered. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<int, Handler> handlers_; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ForwardingMessageFilter); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace IPC 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // IPC_IPC_FORWARDING_MESSAGE_FILTER_H_ 71