← Back to branch summary

~mterry/mir/session-for-surface

« back to all changes in this revision

Viewing changes to include/test/mir_test_framework/cross_process_sync.h

  • Committer: Michael Terry
  • Date: 2013-07-29 17:51:51 UTC
  • mfrom: (832.1.58 trunk)
  • Revision ID: michael.terry@canonical.com-20130729175151-3thcnlepeihhzbb8
Merge from trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/test/mir_test_framework/cross_process_sync.h
 
1
/*
 
2
 * Copyright © 2012 Canonical Ltd.
 
3
 *
 
4
 * This program is free software: you can redistribute it and/or modify it
 
5
 * under the terms of the GNU General Public License version 3,
 
6
 * as published by the Free Software Foundation.
 
7
 *
 
8
 * This program is distributed in the hope that it will be useful,
 
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 * GNU General Public License for more details.
 
12
 *
 
13
 * You should have received a copy of the GNU General Public License
 
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
15
 *
 
16
 * Authored by: Thomas Voss <thomas.voss@canonical.com>
 
17
 */
 
18
 
 
19
#ifndef MIR_TEST_FRAMEWORK_CROSS_PROCESS_SYNC_H_
 
20
#define MIR_TEST_FRAMEWORK_CROSS_PROCESS_SYNC_H_
 
21
 
 
22
#include <chrono>
 
23
 
 
24
namespace mir_test_framework
 
25
{
 
26
// A cross-process synchronization primitive that supports simple
 
27
// wait-condition-like scenarios.
 
28
class CrossProcessSync
 
29
{
 
30
  public:
 
31
    CrossProcessSync();
 
32
    CrossProcessSync(const CrossProcessSync& rhs);
 
33
    ~CrossProcessSync() noexcept;
 
34
 
 
35
    CrossProcessSync& operator=(const CrossProcessSync& rhs);
 
36
 
 
37
    // Try to signal the other side that we are ready for at most duration milliseconds.
 
38
    // Throws a std::runtime_error if not successful.
 
39
    void try_signal_ready_for(
 
40
        const std::chrono::milliseconds& duration = std::chrono::milliseconds(2000));
 
41
 
 
42
    // Wait for the other sides to signal readiness for at most duration milliseconds.
 
43
    // Returns the number of ready signals that have been collected since creation.
 
44
    // Throws std::runtime_error if not successful.
 
45
    unsigned int wait_for_signal_ready_for(
 
46
        const std::chrono::milliseconds& duration = std::chrono::milliseconds(2000));
 
47
  
 
48
  private:
 
49
    int fds[2];
 
50
    unsigned int counter;
 
51
};
 
52
}
 
53
 
 
54
#endif // MIR_TEST_FRAMEWORK_CROSS_PROCESS_SYNC_H_