Line data    Source code

       1             : /*
       2             :  *
       3             :  * Copyright 2015, Google Inc.
       4             :  * All rights reserved.
       5             :  *
       6             :  * Redistribution and use in source and binary forms, with or without
       7             :  * modification, are permitted provided that the following conditions are
       8             :  * met:
       9             :  *
      10             :  *     * Redistributions of source code must retain the above copyright
      11             :  * notice, this list of conditions and the following disclaimer.
      12             :  *     * Redistributions in binary form must reproduce the above
      13             :  * copyright notice, this list of conditions and the following disclaimer
      14             :  * in the documentation and/or other materials provided with the
      15             :  * distribution.
      16             :  *     * Neither the name of Google Inc. nor the names of its
      17             :  * contributors may be used to endorse or promote products derived from
      18             :  * this software without specific prior written permission.
      19             :  *
      20             :  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
      21             :  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
      22             :  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
      23             :  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
      24             :  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
      25             :  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
      26             :  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
      27             :  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      28             :  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
      29             :  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
      30             :  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
      31             :  *
      32             :  */
      33             : 
      34             : #ifndef GRPCXX_SUPPORT_STATUS_H
      35             : #define GRPCXX_SUPPORT_STATUS_H
      36             : 
      37             : #include <grpc++/support/config.h>
      38             : #include <grpc++/support/status_code_enum.h>
      39             : 
      40             : namespace grpc {
      41             : 
      42             : /// Did it work? If it didn't, why?
      43             : ///
      44             : /// See \a grpc::StatusCode for details on the available code and their meaning.
      45    24538516 : class Status {
      46             :  public:
      47             :   /// Construct an OK instance.
      48     1139591 :   Status() : code_(StatusCode::OK) {}
      49             : 
      50             :   /// Construct an instance with associated \a code and \a details (also
      51             :   // referred to as "error_message").
      52     1299196 :   Status(StatusCode code, const grpc::string& details)
      53     1299196 :       : code_(code), details_(details) {}
      54             : 
      55             :   // Pre-defined special status objects.
      56             :   /// An OK pre-defined instance.
      57             :   static const Status& OK;
      58             :   /// A CANCELLED pre-defined instance.
      59             :   static const Status& CANCELLED;
      60             : 
      61             :   /// Return the instance's error code.
      62     1299074 :   StatusCode error_code() const { return code_; }
      63             :   /// Return the instance's error message.
      64     1299055 :   grpc::string error_message() const { return details_; }
      65             : 
      66             :   /// Is the status OK?
      67     5741951 :   bool ok() const { return code_ == StatusCode::OK; }
      68             : 
      69             :  private:
      70             :   StatusCode code_;
      71             :   grpc::string details_;
      72             : };
      73             : 
      74             : }  // namespace grpc
      75             : 
      76             : #endif  // GRPCXX_SUPPORT_STATUS_H