zecfoundation
/
zcashd
mirror of https://github.com/ZcashFoundation/zcashd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update formatting and documentation.

This commit is contained in:
Simon 2016-09-07 19:39:33 -07:00
parent ca0ec80b4c
commit 61ea2abaf5
3 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/asyncrpcoperation.cpp
View File

@ -38,7 +38,8 @@ AsyncRPCOperation::AsyncRPCOperation() : error_code_(0), error_message_() {
creation_time_ = (int64_t)time(NULL);
}
AsyncRPCOperation::AsyncRPCOperation(const AsyncRPCOperation& o) : id_(o.id_), creation_time_(o.creation_time_), state_(o.state_.load())
AsyncRPCOperation::AsyncRPCOperation(const AsyncRPCOperation& o) :
id_(o.id_), creation_time_(o.creation_time_), state_(o.state_.load())
{
}
@ -107,6 +108,7 @@ void AsyncRPCOperation::main() {
/**
* Return the error of the completed operation as a Value object.
* If there is no error, return null Value.
*/
Value AsyncRPCOperation::getError() const {
if (!isFailed()) {
@ -121,6 +123,7 @@ Value AsyncRPCOperation::getError() const {
/**
* Return the result of the completed operation as a Value object.
* If the operation did not succeed, return null Value.
*/
Value AsyncRPCOperation::getResult() const {
if (!isSuccess()) {
@ -135,6 +138,7 @@ Value AsyncRPCOperation::getResult() const {
* Returns a status Value object.
* If the operation has failed, it will include an error object.
* If the operation has succeeded, it will include the result value.
* If the operation was cancelled, there will be no error object or result value.
*/
Value AsyncRPCOperation::getStatus() const {
OperationStatus status = this->getState();
@ -142,7 +146,7 @@ Value AsyncRPCOperation::getStatus() const {
obj.push_back(Pair("id", this->getId()));
obj.push_back(Pair("status", OperationStatusMap[status]));
obj.push_back(Pair("creation_time", this->creation_time_));
// creation, exec time, duration, exec end, etc.
// TODO: Issue #1354: There may be other useful metadata to return to the user.
Value err = this->getError();
if (!err.is_null()) {
obj.push_back(Pair("error", err.get_obj()));

8
src/asyncrpcoperation.h
View File

@ -99,7 +99,13 @@ public:
}
protected:
// The state_ is atomic because only it can be mutated externally.
// For example, the user initiates a shut down of the application, which closes
// the AsyncRPCQueue, which in turn invokes cancel() on all operations.
// The member variables below are protected rather than private in order to
// allow subclasses of AsyncRPCOperation the ability to access and update
// internal state. Currently, all operations are executed in a single-thread
// by a single worker.
Value result_;
int error_code_;
std::string error_message_;