1
0
Fork 0
arangodb/arangosh/Benchmark/BenchmarkOperation.h

107 lines
4.1 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief interface definition for benchmark operations
///
/// @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 Jan Steemann
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
/// @author Copyright 2012-2013, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGODB_BENCHMARK_BENCHMARK_OPERATION_H
#define ARANGODB_BENCHMARK_BENCHMARK_OPERATION_H 1
#include "Basics/Common.h"
#include "SimpleHttpClient/SimpleHttpClient.h"
namespace triagens {
namespace arangob {
// -----------------------------------------------------------------------------
// --SECTION-- class BenchmarkOperation
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @brief simple interface for benchmark operations
////////////////////////////////////////////////////////////////////////////////
struct BenchmarkOperation {
////////////////////////////////////////////////////////////////////////////////
/// @brief ctor, derived class can implemented something sensible
////////////////////////////////////////////////////////////////////////////////
BenchmarkOperation () {
}
////////////////////////////////////////////////////////////////////////////////
/// @brief dtor, derived class can implemented something sensible
////////////////////////////////////////////////////////////////////////////////
virtual ~BenchmarkOperation () {
}
////////////////////////////////////////////////////////////////////////////////
/// @brief setup
////////////////////////////////////////////////////////////////////////////////
virtual bool setUp (triagens::httpclient::SimpleHttpClient*) = 0;
////////////////////////////////////////////////////////////////////////////////
/// @brief teardown
////////////////////////////////////////////////////////////////////////////////
virtual void tearDown () = 0;
////////////////////////////////////////////////////////////////////////////////
/// @brief return the URL of the operation to execute
////////////////////////////////////////////////////////////////////////////////
virtual std::string url (const int, const size_t, const size_t) = 0;
////////////////////////////////////////////////////////////////////////////////
/// @brief return the HTTP method of the operation to execute
////////////////////////////////////////////////////////////////////////////////
virtual triagens::rest::HttpRequest::HttpRequestType type (const int, const size_t, const size_t) = 0;
////////////////////////////////////////////////////////////////////////////////
/// @brief return the payload (body) of the HTTP request to execute
////////////////////////////////////////////////////////////////////////////////
virtual const char* payload (size_t*, const int, const size_t, const size_t, bool*) = 0;
};
}
}
#endif
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: