← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gears/karmic

« back to all changes in this revision

Viewing changes to gears/base/common/async_router.h

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Lesicnik
  • Date: 2009-04-30 19:15:25 UTC
  • Revision ID: james.westby@ubuntu.com-20090430191525-0790sb5wzg8ou0xb
Tags: upstream-0.5.21.0~svn3334+dfsg
Import upstream version 0.5.21.0~svn3334+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
gears/base/common/async_router.h
 
1
// Copyright 2008, Google Inc.
 
2
//
 
3
// Redistribution and use in source and binary forms, with or without 
 
4
// modification, are permitted provided that the following conditions are met:
 
5
//
 
6
//  1. Redistributions of source code must retain the above copyright notice, 
 
7
//     this list of conditions and the following disclaimer.
 
8
//  2. Redistributions in binary form must reproduce the above copyright notice,
 
9
//     this list of conditions and the following disclaimer in the documentation
 
10
//     and/or other materials provided with the distribution.
 
11
//  3. Neither the name of Google Inc. nor the names of its contributors may be
 
12
//     used to endorse or promote products derived from this software without
 
13
//     specific prior written permission.
 
14
//
 
15
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 
16
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 
17
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 
18
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 
19
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
20
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
21
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
22
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 
23
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 
24
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
25
 
 
26
#ifndef GEARS_BASE_COMMON_ASYNC_ROUTER_H__
 
27
#define GEARS_BASE_COMMON_ASYNC_ROUTER_H__
 
28
 
 
29
#include "gears/base/common/basictypes.h" // for DISALLOW_EVIL_CONSTRUCTORS
 
30
#include "gears/base/common/message_queue.h"
 
31
 
 
32
// Clients implement this interface to receive an asynchronous call.
 
33
class AsyncFunctor : public MessageData {
 
34
public:
 
35
  virtual void Run() = 0;
 
36
};
 
37
 
 
38
// Clients implement this interface to receive a synchronous call.
 
39
//
 
40
// WARNING: Make certain Run does minimal work.  If this results in a sync call
 
41
// back to the source thread, it will deadlock.
 
42
class SyncFunctor : public MessageData {
 
43
public:
 
44
  virtual void Run() = 0;
 
45
 
 
46
  friend class AsyncRouter;
 
47
 
 
48
private:
 
49
  void SignalHandledEvent() {
 
50
    handled_event_->Signal();
 
51
  }
 
52
 
 
53
  void SetHandledEvent(Event *handled_event) {
 
54
    handled_event_ = handled_event;
 
55
  }
 
56
 
 
57
  Event *handled_event_;
 
58
};
 
59
 
 
60
// This is a simple class that facilitates running a method asynchronously on
 
61
// a target thread.  The ThreadMessageQueue with the given thread_id must be
 
62
// initialized.
 
63
class AsyncRouter : public ThreadMessageQueue::HandlerInterface {
 
64
 public:
 
65
  // Returns a pointer to the AsyncRouter singleton.
 
66
  static AsyncRouter *GetInstance();
 
67
 
 
68
  // Calls the functor's Run() method from the thread specified by thread_id.
 
69
  // Ownership of the functor is transferred to the AsyncRouter.
 
70
  bool CallAsync(ThreadId thread_id, AsyncFunctor *functor);
 
71
 
 
72
  bool CallSync(ThreadId thread_id, SyncFunctor *functor);
 
73
 
 
74
 private:
 
75
  AsyncRouter();
 
76
  ~AsyncRouter();
 
77
 
 
78
  // ThreadMessageQueue::HandlerInterface override
 
79
  virtual void HandleThreadMessage(int message_type, MessageData *message_data);
 
80
 
 
81
  DISALLOW_EVIL_CONSTRUCTORS(AsyncRouter);
 
82
};
 
83
 
 
84
#endif  // GEARS_BASE_COMMON_ASYNC_ROUTER_H__