mirror of https://gitee.com/bigwinds/arangodb
269 lines
9.2 KiB
C++
269 lines
9.2 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief http request result
|
|
///
|
|
/// @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 Achim Brandt
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2008-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_SIMPLE_HTTP_CLIENT_SIMPLE_HTTP_RESULT_H
|
|
#define ARANGODB_SIMPLE_HTTP_CLIENT_SIMPLE_HTTP_RESULT_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "Basics/StringBuffer.h"
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief class for storing a request result
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
namespace triagens {
|
|
namespace httpclient {
|
|
|
|
class SimpleHttpResult {
|
|
private:
|
|
SimpleHttpResult (SimpleHttpResult const&);
|
|
SimpleHttpResult& operator= (SimpleHttpResult const&);
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief result types
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
enum resultTypes {
|
|
COMPLETE = 0,
|
|
COULD_NOT_CONNECT,
|
|
WRITE_ERROR,
|
|
READ_ERROR,
|
|
UNKNOWN
|
|
};
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief constructor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
SimpleHttpResult ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief destructor
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
~SimpleHttpResult ();
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief clear result values
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void clear ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns whether the response contains an HTTP error
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool wasHttpError () const {
|
|
return (_returnCode >= 400);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the http return code
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int getHttpReturnCode () const {
|
|
return _returnCode;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets the http return code
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void setHttpReturnCode (int returnCode) {
|
|
this->_returnCode = returnCode;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the http return message
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string getHttpReturnMessage () const {
|
|
return _returnMessage;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets the http return message
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void setHttpReturnMessage (const std::string& message) {
|
|
this->_returnMessage = message;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the response contained a content length header
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool hasContentLength () const {
|
|
return _hasContentLength;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the content length
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t getContentLength () const {
|
|
return _contentLength;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets the content length
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void setContentLength (size_t len) {
|
|
_contentLength = len;
|
|
_hasContentLength = true;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the http body
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
triagens::basics::StringBuffer& getBody ();
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the request result type
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
enum resultTypes getResultType () const {
|
|
return _requestResultType;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns true if result type == OK
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool isComplete () const {
|
|
return _requestResultType == COMPLETE;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns true if "transfer-encoding: chunked"
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool isChunked () const {
|
|
return _chunked;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns true if "content-encoding: deflate"
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool isDeflated () const {
|
|
return _deflated;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets the request result type
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void setResultType (enum resultTypes requestResultType) {
|
|
this->_requestResultType = requestResultType;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns a message for the result type
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string getResultTypeMessage () const;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief add header field
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void addHeaderField (char const*, size_t);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return the value of a single header
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string getHeaderField (std::string const&, bool&) const;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get all header fields
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::map<std::string, std::string> const& getHeaderFields () const {
|
|
return _headerFields;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns whether the result is JSON-encoded
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool isJson () const;
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief add header field
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void addHeaderField (char const*, size_t, char const*, size_t);
|
|
|
|
|
|
private:
|
|
|
|
// header informtion
|
|
std::string _returnMessage;
|
|
size_t _contentLength;
|
|
int _returnCode;
|
|
bool _foundHeader;
|
|
bool _hasContentLength;
|
|
bool _chunked;
|
|
bool _deflated;
|
|
|
|
// body content
|
|
triagens::basics::StringBuffer _resultBody;
|
|
|
|
// request result type
|
|
enum resultTypes _requestResultType;
|
|
|
|
// header fields
|
|
std::map<std::string, std::string> _headerFields;
|
|
};
|
|
}
|
|
}
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|