2000-12-15 09:14:03 -06:00
|
|
|
/*************************************************************************
|
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* $RCSfile: disposetimer.hxx,v $
|
|
|
|
* $Revision: 1.15 $
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* This file is part of OpenOffice.org.
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
|
|
* only, as published by the Free Software Foundation.
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* OpenOffice.org 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 version 3 for more details
|
|
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
2008-04-11 07:40:50 -05:00
|
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
|
|
* <http://www.openoffice.org/license.html>
|
|
|
|
* for a copy of the LGPLv3 License.
|
2000-12-15 09:14:03 -06:00
|
|
|
*
|
|
|
|
************************************************************************/
|
|
|
|
|
|
|
|
#ifndef CONFIGMGR_DISPOSETIMER_HXX
|
|
|
|
#define CONFIGMGR_DISPOSETIMER_HXX
|
|
|
|
|
2002-03-28 02:08:05 -06:00
|
|
|
#include "timestamp.hxx"
|
|
|
|
#include "requestoptions.hxx"
|
|
|
|
#include <osl/mutex.hxx>
|
|
|
|
#include <vos/timer.hxx>
|
|
|
|
#include <vos/ref.hxx>
|
2001-02-13 09:14:17 -06:00
|
|
|
#include <com/sun/star/lang/WrappedTargetException.hpp>
|
|
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
|
|
|
2002-03-28 02:08:05 -06:00
|
|
|
#ifndef INCLUDED_UTILITY
|
|
|
|
#include <utility>
|
|
|
|
#define INCLUDED_UTILITY
|
|
|
|
#endif
|
|
|
|
#ifndef INCLUDED_MAP
|
2000-12-15 09:14:03 -06:00
|
|
|
#include <map>
|
2002-03-28 02:08:05 -06:00
|
|
|
#define INCLUDED_MAP
|
|
|
|
#endif
|
2000-12-15 09:14:03 -06:00
|
|
|
|
2001-02-13 09:14:17 -06:00
|
|
|
namespace uno = ::com::sun::star::uno;
|
|
|
|
namespace lang = ::com::sun::star::lang;
|
|
|
|
|
2000-12-15 09:14:03 -06:00
|
|
|
namespace configmgr
|
|
|
|
{
|
2002-03-28 02:08:05 -06:00
|
|
|
namespace backend { class CacheController; }
|
2000-12-15 09:14:03 -06:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
2001-01-17 08:02:34 -06:00
|
|
|
/* OTreeDisposeScheduler:
|
|
|
|
does something special????
|
|
|
|
*/
|
|
|
|
|
2000-12-15 09:14:03 -06:00
|
|
|
class OTreeDisposeScheduler
|
|
|
|
{
|
2002-03-28 02:08:05 -06:00
|
|
|
typedef std::multimap< TimeStamp, RequestOptions, ltTimeStamp > Agenda;
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
class Timer : public vos::OTimer
|
|
|
|
{
|
|
|
|
public:
|
2001-02-15 10:15:21 -06:00
|
|
|
OTreeDisposeScheduler* pParent;
|
2000-12-15 09:14:03 -06:00
|
|
|
|
2001-02-15 10:15:21 -06:00
|
|
|
Timer(OTreeDisposeScheduler& _rParent) : pParent(&_rParent) {};
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
// vos::OTimer
|
|
|
|
virtual void SAL_CALL onShot();
|
2001-02-15 10:15:21 -06:00
|
|
|
|
|
|
|
// stop the scheduling
|
|
|
|
void dispose() {stop(); pParent = NULL;}
|
2000-12-15 09:14:03 -06:00
|
|
|
};
|
|
|
|
friend void Timer::onShot();
|
|
|
|
|
|
|
|
private:
|
|
|
|
Agenda m_aAgenda;
|
|
|
|
vos::ORef<Timer> m_xTimer;
|
2008-10-29 09:38:47 -05:00
|
|
|
backend::CacheController& m_rTreeManager;
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
TimeInterval m_aCleanupDelay;
|
|
|
|
TimeInterval m_aCleanupInterval;
|
|
|
|
public:
|
|
|
|
//-------- Construction and destruction -----------------------------------
|
|
|
|
explicit
|
2008-10-29 09:38:47 -05:00
|
|
|
OTreeDisposeScheduler(backend::CacheController& _rTreeManager, TimeInterval const& _aCleanupDelay)
|
2001-02-15 10:15:21 -06:00
|
|
|
: m_rTreeManager(_rTreeManager)
|
2000-12-15 09:14:03 -06:00
|
|
|
, m_aCleanupDelay(_aCleanupDelay)
|
|
|
|
, m_aCleanupInterval(_aCleanupDelay)
|
2001-02-15 10:15:21 -06:00
|
|
|
{
|
|
|
|
m_xTimer = new Timer(*this);
|
|
|
|
}
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
explicit
|
2008-10-29 09:38:47 -05:00
|
|
|
OTreeDisposeScheduler(backend::CacheController& _rTreeManager, TimeInterval const& _aCleanupDelay, TimeInterval const& _aCleanupInterval)
|
2001-02-15 10:15:21 -06:00
|
|
|
: m_rTreeManager(_rTreeManager)
|
2000-12-15 09:14:03 -06:00
|
|
|
, m_aCleanupDelay(_aCleanupDelay)
|
|
|
|
, m_aCleanupInterval(_aCleanupInterval)
|
2001-02-15 10:15:21 -06:00
|
|
|
{
|
|
|
|
m_xTimer = new Timer(*this);
|
|
|
|
}
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
~OTreeDisposeScheduler() { stopAndClearTasks(); }
|
|
|
|
|
2007-11-23 07:38:18 -06:00
|
|
|
//-------- Delay and Interval ---------------------------------------------
|
2000-12-15 09:14:03 -06:00
|
|
|
/// sets the initial delay to be used for cleanup in the future, does not affect an already started process
|
|
|
|
void setCleanupDelay(TimeInterval const& _aCleanupDelay)
|
|
|
|
{
|
|
|
|
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)
|
|
|
|
{
|
|
|
|
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)
|
|
|
|
{
|
|
|
|
m_aCleanupInterval = _aCleanupInterval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// retrieves the initial delay used for cleanup
|
|
|
|
TimeInterval const& getCleanupDelay() const
|
|
|
|
{
|
|
|
|
return m_aCleanupDelay;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// retrieves the recurrance interval used for cleanup
|
|
|
|
TimeInterval const& getCleanupInterval() const
|
|
|
|
{
|
|
|
|
return m_aCleanupInterval;
|
|
|
|
}
|
|
|
|
|
|
|
|
//-------- Control of execution ------------------------------------------
|
|
|
|
/// ensure this will execute cleanup duties for _xOptions (no later than after getCleanupDelay() has elapsed)
|
2002-03-15 04:50:25 -06:00
|
|
|
void scheduleCleanup(RequestOptions const & _aOptions);
|
2000-12-15 09:14:03 -06:00
|
|
|
|
|
|
|
/// stop and discard pending activities
|
|
|
|
void stopAndClearTasks();
|
2001-02-15 10:15:21 -06:00
|
|
|
|
2000-12-15 09:14:03 -06:00
|
|
|
private:
|
|
|
|
// vos::OTimer
|
|
|
|
void onTimerShot();
|
|
|
|
|
2008-10-29 09:38:47 -05:00
|
|
|
std::pair<bool,RequestOptions> getTask(TimeStamp const& _aActualTime, TimeStamp& _aNextTime);
|
2000-12-15 09:14:03 -06:00
|
|
|
|
2002-03-15 04:50:25 -06:00
|
|
|
/// ensure this will execute cleanup duties for _xOptions (no later than after getCleanupDelay() has elapsed)
|
|
|
|
// TimeStamp fillDisposeList(CacheLoadingAccess & _aCache, DisposeList& _rList, TimeStamp const& aLimitTime)
|
|
|
|
|
2000-12-15 09:14:03 -06:00
|
|
|
TimeStamp runDisposer(TimeStamp const& _aActualTime);
|
|
|
|
private:
|
2002-03-28 02:08:05 -06:00
|
|
|
TimeStamp implAddTask(RequestOptions const& _xOptions, TimeStamp const& _aTime);
|
2000-12-15 09:14:03 -06:00
|
|
|
void implStartBefore(TimeStamp const& _aTime);
|
|
|
|
|
2002-03-28 02:08:05 -06:00
|
|
|
static TimeStamp implGetCleanupTime(TimeStamp const& aPostingTime, TimeInterval const& aDelay)
|
|
|
|
{ return aPostingTime + aDelay; }
|
2000-12-15 09:14:03 -06:00
|
|
|
};
|
|
|
|
|
2001-01-17 08:02:34 -06:00
|
|
|
|
2000-12-15 09:14:03 -06:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
} // namespace configmgr
|
|
|
|
|
|
|
|
#endif // CONFIGMGR_DISPOSETIMER_HXX
|
|
|
|
|