summaryrefslogtreecommitdiff
path: root/framework/source/threadhelp/gate.cxx
blob: a490a51ef2f9ea62a4f2d580d110d0f3bffbde71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: gate.cxx,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: obo $ $Date: 2006-09-16 14:13:25 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_framework.hxx"

//_________________________________________________________________________________________________________________
//  my own includes
//_________________________________________________________________________________________________________________

#ifndef __FRAMEWORK_THREADHELP_GATE_HXX_
#include <threadhelp/gate.hxx>
#endif

#ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
#include <threadhelp/resetableguard.hxx>
#endif

//_________________________________________________________________________________________________________________
//  interface includes
//_________________________________________________________________________________________________________________

//_________________________________________________________________________________________________________________
//  other includes
//_________________________________________________________________________________________________________________

//_________________________________________________________________________________________________________________
//  const
//_________________________________________________________________________________________________________________

//_________________________________________________________________________________________________________________
//  namespace
//_________________________________________________________________________________________________________________

namespace framework{

//_________________________________________________________________________________________________________________
//  non exported const
//_________________________________________________________________________________________________________________

//_________________________________________________________________________________________________________________
//  non exported declarations
//_________________________________________________________________________________________________________________

//_________________________________________________________________________________________________________________
//  definitions
//_________________________________________________________________________________________________________________

//*****************************************************************************************************************
//  constructor
//*****************************************************************************************************************
Gate::Gate()
    :   m_bClosed   ( sal_False )
    ,   m_bGapOpen  ( sal_False )
{
    open();
}

//*****************************************************************************************************************
//  destructor
//*****************************************************************************************************************
Gate::~Gate()
{
    open();
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void Gate::open()
{
    // We must safe access to our internal member!
    ResetableGuard aLock( m_aAccessLock );
    // Set condition -> wait don't block any longer -> gate is open
    m_aPassage.set();
    // Check if operation was successful!
    // Check returns false if condition isn't set => m_bClosed will be true then => we must return false; opening failed
    m_bClosed = ( m_aPassage.check() == sal_False );
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void Gate::close()
{
    // We must safe access to our internal member!
    ResetableGuard aLock( m_aAccessLock );
    // Reset condition -> wait blocks now -> gate is closed
    m_aPassage.reset();
    // Check if operation was successful!
    // Check returns false if condition was reseted => m_bClosed will be true then => we can return true; closing ok
    m_bClosed = ( m_aPassage.check() == sal_False );
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
void Gate::openGap()
{
    // We must safe access to our internal member!
    ResetableGuard aLock( m_aAccessLock );
    // Open passage for current waiting threads.
    m_aPassage.set();
    // Check state of condition.
    // If condition is set check() returns true => m_bGapOpen will be true too => we can use it as return value.
    m_bGapOpen = ( m_aPassage.check() == sal_True );
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool Gate::wait( const TimeValue* pTimeOut )
{
    // We must safe access to our internal member!
    ResetableGuard aLock( m_aAccessLock );
    // If gate not closed - caller can pass it.
    sal_Bool bSuccessful = sal_True;
    if( m_bClosed == sal_True )
    {
        // Otherwise first new thread must close an open gap!
        if( m_bGapOpen == sal_True )
        {
            m_bGapOpen = sal_False;
            m_aPassage.reset();
        }
        // Then we must release used access lock -
        // because next call will block ...
        // and if we hold the access lock nobody else can use this object without a dadlock!
        aLock.unlock();
        // Wait for opening gate ...
        bSuccessful = ( m_aPassage.wait( pTimeOut ) == osl_cond_result_ok );
    }

    return bSuccessful;
}

//*****************************************************************************************************************
//  public method
//*****************************************************************************************************************
sal_Bool Gate::isOpen() const
{
    // I think we never need the access lock for pure reading of this bool member ...
    return !m_bClosed;
}

}   //  namespace framework