1
0
Fork 0
arangodb/arangod/V8Server/V8TimerTask.h

176 lines
6.2 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief timed V8 task
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// Licensed 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
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2014, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGODB_V8SERVER_V8TIMER_TASK_H
#define ARANGODB_V8SERVER_V8TIMER_TASK_H 1
#include "Basics/Common.h"
#include "Scheduler/TimerTask.h"
#include "VocBase/vocbase.h"
struct TRI_json_t;
// -----------------------------------------------------------------------------
// --SECTION-- class V8TimerTask
// -----------------------------------------------------------------------------
namespace triagens {
namespace rest {
class Dispatcher;
class Scheduler;
}
namespace arango {
class ApplicationV8;
class V8TimerTask : public rest::TimerTask {
// -----------------------------------------------------------------------------
// --SECTION-- constructors and destructors
// -----------------------------------------------------------------------------
public:
////////////////////////////////////////////////////////////////////////////////
/// @brief constructor
////////////////////////////////////////////////////////////////////////////////
V8TimerTask (std::string const&,
std::string const&,
TRI_vocbase_t*,
ApplicationV8*,
rest::Scheduler*,
rest::Dispatcher*,
double,
std::string const&,
struct TRI_json_t*,
bool);
////////////////////////////////////////////////////////////////////////////////
/// @brief destructor
////////////////////////////////////////////////////////////////////////////////
~V8TimerTask ();
// -----------------------------------------------------------------------------
// --SECTION-- protected methods
// -----------------------------------------------------------------------------
protected:
////////////////////////////////////////////////////////////////////////////////
/// @brief get a task specific description in JSON format
////////////////////////////////////////////////////////////////////////////////
void getDescription (struct TRI_json_t*) const override;
////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the task is user-defined
////////////////////////////////////////////////////////////////////////////////
bool isUserDefined () const override {
return true;
}
// -----------------------------------------------------------------------------
// --SECTION-- PeriodicTask methods
// -----------------------------------------------------------------------------
public:
////////////////////////////////////////////////////////////////////////////////
/// @brief handles the timer event
////////////////////////////////////////////////////////////////////////////////
bool handleTimeout () override;
// -----------------------------------------------------------------------------
// --SECTION-- private variables
// -----------------------------------------------------------------------------
private:
////////////////////////////////////////////////////////////////////////////////
/// @brief system vocbase
////////////////////////////////////////////////////////////////////////////////
TRI_vocbase_t* _vocbase;
////////////////////////////////////////////////////////////////////////////////
/// @brief V8 dealer
////////////////////////////////////////////////////////////////////////////////
arango::ApplicationV8* _v8Dealer;
////////////////////////////////////////////////////////////////////////////////
/// @brief dispatcher
////////////////////////////////////////////////////////////////////////////////
rest::Dispatcher* _dispatcher;
////////////////////////////////////////////////////////////////////////////////
/// @brief command to execute
////////////////////////////////////////////////////////////////////////////////
std::string const _command;
////////////////////////////////////////////////////////////////////////////////
/// @brief paramaters
////////////////////////////////////////////////////////////////////////////////
struct TRI_json_t* _parameters;
////////////////////////////////////////////////////////////////////////////////
/// @brief creation timestamp
////////////////////////////////////////////////////////////////////////////////
double _created;
////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the task is allowed to switch the database
////////////////////////////////////////////////////////////////////////////////
bool _allowUseDatabase;
};
}
}
#endif
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: