LibreOffice LibreOffice 25.8 SDK C/C++ API Reference

Loading...
Searching...
No Matches
condition.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_SALHELPER_CONDITION_HXX
25#define INCLUDED_SALHELPER_CONDITION_HXX
26
27
28#include "osl/conditn.hxx"
29#include "salhelper/salhelperdllapi.h"
30
31 namespace osl { class Mutex; }
32
33 namespace salhelper
34{
35
36 class SALHELPER_DLLPUBLIC Condition
37 {
38 friend class ConditionModifier;
39 friend class ConditionWaiter;
40
41 public:
42
43 Condition(osl::Mutex& aMutex);
44
45 virtual ~Condition();
46
47
48 protected:
49
50 virtual bool applies() const = 0;
51
52
53 private:
54 Condition(Condition &) SAL_DELETED_FUNCTION;
55 void operator =(Condition &) SAL_DELETED_FUNCTION;
56
57 osl::Mutex& m_aMutex;
58 osl::Condition m_aCondition;
59 };
60
61
62 class SALHELPER_DLLPUBLIC ConditionModifier
63 {
64 public:
65
66 ConditionModifier(Condition& aCond);
67
68 ~ConditionModifier();
69
70
71 private:
72 ConditionModifier(ConditionModifier &) SAL_DELETED_FUNCTION;
73 void operator =(ConditionModifier &) SAL_DELETED_FUNCTION;
74
75 Condition& m_aCond;
76 };
77
78
79 class SALHELPER_DLLPUBLIC ConditionWaiter
80 {
81 public:
82
83 ConditionWaiter(Condition& aCond);
84
85 struct SALHELPER_DLLPUBLIC timedout {
86 timedout();
87
88 timedout(timedout const &);
89
90 virtual ~timedout();
91
92 timedout & operator =(timedout const &);
93 };
94
96 ConditionWaiter(Condition& aCond,sal_uInt32 milliSec);
97
98
99 ~ConditionWaiter();
100
101
102 private:
103 ConditionWaiter(ConditionWaiter &) SAL_DELETED_FUNCTION;
104 void operator =(ConditionWaiter &) SAL_DELETED_FUNCTION;
105
106 Condition& m_aCond;
107 };
108
109
110} // namespace salhelper
111
112
113#endif
114
115/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition types.h:396
salhelperdllapi.h
SALHELPER_DLLPUBLIC
#define SALHELPER_DLLPUBLIC
Definition salhelperdllapi.h:32
conditn.hxx
osl
Definition condition.hxx:31
salhelper
Definition condition.hxx:34
salhelper::Condition
Definition condition.hxx:37
salhelper::Condition::~Condition
virtual ~Condition()
salhelper::Condition::Condition
Condition(osl::Mutex &aMutex)
salhelper::Condition::ConditionWaiter
friend class ConditionWaiter
Definition condition.hxx:39
salhelper::Condition::applies
virtual bool applies() const =0
salhelper::Condition::ConditionModifier
friend class ConditionModifier
Definition condition.hxx:38
salhelper::ConditionModifier::ConditionModifier
ConditionModifier(Condition &aCond)
salhelper::ConditionModifier::~ConditionModifier
~ConditionModifier()
salhelper::ConditionWaiter::~ConditionWaiter
~ConditionWaiter()
salhelper::ConditionWaiter::ConditionWaiter
ConditionWaiter(Condition &aCond, sal_uInt32 milliSec)
salhelper::ConditionWaiter::ConditionWaiter
ConditionWaiter(Condition &aCond)
salhelper::ConditionWaiter::timedout::~timedout
virtual ~timedout()
salhelper::ConditionWaiter::timedout::timedout
timedout()
salhelper::ConditionWaiter::timedout::timedout
timedout(timedout const &)
osl::Condition
Condition variable.
Definition conditn.hxx:60
osl::Mutex
A mutual exclusion synchronization object.
Definition mutex.hxx:35