LibreOffice LibreOffice 4.4 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

conditn.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 #ifndef INCLUDED_OSL_CONDITN_HXX
21 #define INCLUDED_OSL_CONDITN_HXX
22
23 #include <osl/time.h>
24
25 #include <osl/conditn.h>
26
27
28 namespace osl
29 {
38 class Condition
39 {
40 public:
41
42 enum Result
43 {
44 result_ok = osl_cond_result_ok,
45 result_error = osl_cond_result_error,
46 result_timeout = osl_cond_result_timeout
47 };
48
49 /* Create a condition.
50 */
51 Condition()
52 {
53 condition = osl_createCondition();
54 }
55
56 /* Release the OS-structures and free condition data-structure.
57 */
58 ~Condition()
59 {
60 osl_destroyCondition(condition);
61 }
62
63 /* Release all waiting threads, check returns true.
64 */
65 void set()
66 {
67 osl_setCondition(condition);
68 }
69
70 /* Reset condition to false: wait() will block, check() returns false.
71 */
72 void reset() {
73 osl_resetCondition(condition);
74 }
75
78 Result wait(const TimeValue *pTimeout = 0)
79 {
80 return (Result) osl_waitCondition(condition, pTimeout);
81 }
82
85 bool check()
86 {
87 return osl_checkCondition(condition);
88 }
89
90
91 private:
92 oslCondition condition;
93
100 Condition(const Condition&);
101
108 Condition(oslCondition condition);
109
113 Condition& operator= (const Condition&);
114
118 Condition& operator= (oslCondition);
119 };
120
121 }
122
123 #endif // INCLUDED_OSL_CONDITN_HXX
124
125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl::Condition::set
void set()
Definition: conditn.hxx:65
osl_resetCondition
SAL_DLLPUBLIC sal_Bool osl_resetCondition(oslCondition Condition)
Sets condition to False => wait() will block, check() returns False.
osl::Condition::Result
Result
Definition: conditn.hxx:42
osl::Condition::result_error
Definition: conditn.hxx:45
osl::Condition
Warning: the Condition abstraction is inadequate for any situation where there may be multiple thread...
Definition: conditn.hxx:38
osl::Condition::Condition
Condition()
Definition: conditn.hxx:51
osl_createCondition
SAL_DLLPUBLIC oslCondition osl_createCondition(void)
Creates a condition.
osl_cond_result_ok
Definition: conditn.h:36
osl_checkCondition
SAL_DLLPUBLIC sal_Bool osl_checkCondition(oslCondition Condition)
Queries the state of the condition without blocking.
oslCondition
void * oslCondition
Definition: conditn.h:33
osl_waitCondition
SAL_DLLPUBLIC oslConditionResult osl_waitCondition(oslCondition Condition, const TimeValue *pTimeout)
Blocks if condition is not set If condition has been destroyed prematurely, wait() will return with ...
time.h
osl::Condition::~Condition
~Condition()
Definition: conditn.hxx:58
osl::Condition::check
bool check()
Checks if the condition is set without blocking.
Definition: conditn.hxx:85
osl_cond_result_timeout
Definition: conditn.h:38
osl_cond_result_error
Definition: conditn.h:37
osl::Condition::result_timeout
Definition: conditn.hxx:46
osl
Definition: conditn.hxx:28
osl_setCondition
SAL_DLLPUBLIC sal_Bool osl_setCondition(oslCondition Condition)
Sets condition to True => wait() will not block, check() returns True.
osl::Condition::result_ok
Definition: conditn.hxx:44
TimeValue
Definition: time.h:42
osl::Condition::reset
void reset()
Definition: conditn.hxx:72
osl::Condition::wait
Result wait(const TimeValue *pTimeout=0)
Blocks the calling thread until condition is set.
Definition: conditn.hxx:78
conditn.h
osl_destroyCondition
SAL_DLLPUBLIC void osl_destroyCondition(oslCondition Condition)
Free the memory used by the condition.