215 lines
7.1 KiB
C++
215 lines
7.1 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: disposetimer.hxx,v $
|
|
*
|
|
* $Revision: 1.13 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-08 04:24:50 $
|
|
*
|
|
* 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
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef CONFIGMGR_DISPOSETIMER_HXX
|
|
#define CONFIGMGR_DISPOSETIMER_HXX
|
|
|
|
#ifndef CONFIGMGR_TIMESTAMP_HXX
|
|
#include "timestamp.hxx"
|
|
#endif
|
|
#ifndef CONFIGMGR_MISC_REQUESTOPTIONS_HXX_
|
|
#include "requestoptions.hxx"
|
|
#endif
|
|
|
|
#ifndef _OSL_MUTEX_HXX_
|
|
#include <osl/mutex.hxx>
|
|
#endif
|
|
|
|
#ifndef _VOS_TIMER_HXX_
|
|
#include <vos/timer.hxx>
|
|
#endif
|
|
#ifndef _VOS_REF_HXX_
|
|
#include <vos/ref.hxx>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_WRAPPEDTARGETEXCEPTION_HPP_
|
|
#include <com/sun/star/lang/WrappedTargetException.hpp>
|
|
#endif
|
|
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
#endif
|
|
|
|
#ifndef INCLUDED_UTILITY
|
|
#include <utility>
|
|
#define INCLUDED_UTILITY
|
|
#endif
|
|
#ifndef INCLUDED_MAP
|
|
#include <map>
|
|
#define INCLUDED_MAP
|
|
#endif
|
|
|
|
namespace uno = ::com::sun::star::uno;
|
|
namespace lang = ::com::sun::star::lang;
|
|
|
|
namespace configmgr
|
|
{
|
|
namespace backend { class CacheController; }
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/* OTreeDisposeScheduler:
|
|
does something special????
|
|
*/
|
|
|
|
class OTreeDisposeScheduler
|
|
{
|
|
typedef std::multimap< TimeStamp, RequestOptions, ltTimeStamp > Agenda;
|
|
typedef backend::CacheController CacheManager;
|
|
|
|
class Timer : public vos::OTimer
|
|
{
|
|
osl::Mutex m_aMutex;
|
|
public:
|
|
OTreeDisposeScheduler* pParent;
|
|
|
|
Timer(OTreeDisposeScheduler& _rParent) : pParent(&_rParent) {};
|
|
|
|
// vos::OTimer
|
|
virtual void SAL_CALL onShot();
|
|
|
|
//
|
|
osl::Mutex& getShotMutex() {return m_aMutex;}
|
|
|
|
// stop the scheduling
|
|
void dispose() {stop(); pParent = NULL;}
|
|
|
|
};
|
|
friend void Timer::onShot();
|
|
|
|
private:
|
|
mutable osl::Mutex m_aMutex;
|
|
|
|
Agenda m_aAgenda;
|
|
|
|
vos::ORef<Timer> m_xTimer;
|
|
CacheManager& m_rTreeManager;
|
|
|
|
TimeInterval m_aCleanupDelay;
|
|
TimeInterval m_aCleanupInterval;
|
|
public:
|
|
//-------- Construction and destruction -----------------------------------
|
|
explicit
|
|
OTreeDisposeScheduler(CacheManager& _rTreeManager, TimeInterval const& _aCleanupDelay)
|
|
: m_rTreeManager(_rTreeManager)
|
|
, m_aCleanupDelay(_aCleanupDelay)
|
|
, m_aCleanupInterval(_aCleanupDelay)
|
|
{
|
|
m_xTimer = new Timer(*this);
|
|
}
|
|
|
|
explicit
|
|
OTreeDisposeScheduler(CacheManager& _rTreeManager, TimeInterval const& _aCleanupDelay, TimeInterval const& _aCleanupInterval)
|
|
: m_rTreeManager(_rTreeManager)
|
|
, m_aCleanupDelay(_aCleanupDelay)
|
|
, m_aCleanupInterval(_aCleanupInterval)
|
|
{
|
|
m_xTimer = new Timer(*this);
|
|
}
|
|
|
|
~OTreeDisposeScheduler() { stopAndClearTasks(); }
|
|
|
|
//-------- Delay and Interval ---------------------------------------------
|
|
/// sets the initial delay to be used for cleanup in the future, does not affect an already started process
|
|
void setCleanupDelay(TimeInterval const& _aCleanupDelay)
|
|
{
|
|
osl::MutexGuard aGuard(m_aMutex);
|
|
m_aCleanupDelay = _aCleanupDelay;
|
|
}
|
|
|
|
/// sets the initial delay and recurrance interval to be used for cleanup in the future, does not affect an already started process
|
|
void setCleanupDelay(TimeInterval const& _aCleanupDelay, TimeInterval const& _aCleanupInterval)
|
|
{
|
|
osl::MutexGuard aGuard(m_aMutex);
|
|
m_aCleanupDelay = _aCleanupDelay;
|
|
m_aCleanupInterval = _aCleanupInterval;
|
|
}
|
|
|
|
/// sets the recurrance interval to be used for cleanup in the future, does not affect an already started process
|
|
void setCleanupInterval(TimeInterval const& _aCleanupInterval)
|
|
{
|
|
osl::MutexGuard aGuard(m_aMutex);
|
|
m_aCleanupInterval = _aCleanupInterval;
|
|
}
|
|
|
|
/// retrieves the initial delay used for cleanup
|
|
TimeInterval const& getCleanupDelay() const
|
|
{
|
|
osl::MutexGuard aGuard(m_aMutex);
|
|
return m_aCleanupDelay;
|
|
}
|
|
|
|
/// retrieves the recurrance interval used for cleanup
|
|
TimeInterval const& getCleanupInterval() const
|
|
{
|
|
osl::MutexGuard aGuard(m_aMutex);
|
|
return m_aCleanupInterval;
|
|
}
|
|
|
|
//-------- Control of execution ------------------------------------------
|
|
/// ensure this will execute cleanup duties for _xOptions (no later than after getCleanupDelay() has elapsed)
|
|
void scheduleCleanup(RequestOptions const & _aOptions);
|
|
|
|
/// stop and discard pending activities for _xOptions
|
|
void clearTasks(RequestOptions const & _aOptions);
|
|
|
|
/// stop and discard pending activities
|
|
void stopAndClearTasks();
|
|
|
|
/// mutex for synchronisation
|
|
osl::Mutex& getShotMutex() {return m_xTimer->getShotMutex();}
|
|
|
|
private:
|
|
// vos::OTimer
|
|
void onTimerShot();
|
|
|
|
typedef std::pair<bool,RequestOptions> Task;
|
|
Task getTask(TimeStamp const& _aActualTime, TimeStamp& _aNextTime);
|
|
|
|
/// ensure this will execute cleanup duties for _xOptions (no later than after getCleanupDelay() has elapsed)
|
|
// TimeStamp fillDisposeList(CacheLoadingAccess & _aCache, DisposeList& _rList, TimeStamp const& aLimitTime)
|
|
|
|
TimeStamp runDisposer(TimeStamp const& _aActualTime);
|
|
private:
|
|
TimeStamp implAddTask(RequestOptions const& _xOptions, TimeStamp const& _aTime);
|
|
void implStartBefore(TimeStamp const& _aTime);
|
|
|
|
static TimeStamp implGetCleanupTime(TimeStamp const& aPostingTime, TimeInterval const& aDelay)
|
|
{ return aPostingTime + aDelay; }
|
|
};
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
} // namespace configmgr
|
|
|
|
#endif // CONFIGMGR_DISPOSETIMER_HXX
|
|
|