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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SW_SOURCE_CORE_INC_OBSERVABLETHREAD_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_OBSERVABLETHREAD_HXX
#include <osl/thread.hxx>
#include <rtl/ref.hxx>
#include <osl/interlck.h>
#include <salhelper/simplereferenceobject.hxx>
#include <ifinishedthreadlistener.hxx>
#include <memory>
/** class for an observable thread
OD 2007-01-29 #i73788#
Note: A thread is ref-counted. Thus, an instance of a derived class has to
to be hold via a reference. The thread itself assures during its execution,
that the ref-count is increased. Its execution starts with its <run()> method
and ends with its <onTerminated()> method.
Note: A thread can be only observed by one or none thread observer in order
to notify, that the thread has finished its work.
*/
class ObservableThread : public osl::Thread,
public salhelper::SimpleReferenceObject
{
public:
virtual ~ObservableThread() override;
void SetListener( std::weak_ptr< IFinishedThreadListener > const & pThreadListener,
const oslInterlockedCount nThreadID );
static inline void * operator new(std::size_t size)
{ return SimpleReferenceObject::operator new(size); }
static inline void operator delete(void * pointer)
{ SimpleReferenceObject::operator delete(pointer); }
protected:
ObservableThread();
/** intrinsic function of the thread
Important note:
Do not override this method again. Instead override <threadFunction()>.
Otherwise, it's not guaranteed, that its ref-count is increased
during the execution of the thread.
*/
virtual void SAL_CALL run() override;
virtual void threadFunction() = 0;
/** method called, when thread has finished its work
Important note:
Do not override this method again. Instead override <threadFinished()>.
Otherwise, it's not guaranteed, that the ref-count is decreased at
the end of its execution and that the observer is notified, that
the thread has finished its work.
*/
virtual void SAL_CALL onTerminated() override;
private:
oslInterlockedCount mnThreadID;
std::weak_ptr< IFinishedThreadListener > mpThreadListener;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
