| Jorge Canizales | 9409ad8 | 2015-02-18 16:19:56 -0800 | [diff] [blame^] | 1 | /* |
| 2 | * |
| 3 | * Copyright 2014, 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 | |
| Jorge Canizales | 5e0efd9 | 2015-02-17 18:23:58 -0800 | [diff] [blame] | 34 | #import <Foundation/Foundation.h> |
| 35 | |
| 36 | // TODO(jcanizales): Make the domain string public. |
| 37 | extern NSString *const kGRPCErrorDomain; |
| 38 | |
| 39 | // TODO(jcanizales): Make this public and document each code. |
| 40 | typedef NS_ENUM(NSInteger, GRPCErrorCode) { |
| 41 | GRPCErrorCodeCancelled = 1, |
| 42 | GRPCErrorCodeUnknown = 2, |
| 43 | GRPCErrorCodeInvalidArgument = 3, |
| 44 | GRPCErrorCodeDeadlineExceeded = 4, |
| 45 | GRPCErrorCodeNotFound = 5, |
| 46 | GRPCErrorCodeAlreadyExists = 6, |
| 47 | GRPCErrorCodePermissionDenied = 7, |
| 48 | GRPCErrorCodeUnauthenticated = 16, |
| 49 | GRPCErrorCodeResourceExhausted = 8, |
| 50 | GRPCErrorCodeFailedPrecondition = 9, |
| 51 | GRPCErrorCodeAborted = 10, |
| 52 | GRPCErrorCodeOutOfRange = 11, |
| 53 | GRPCErrorCodeUnimplemented = 12, |
| 54 | GRPCErrorCodeInternal = 13, |
| 55 | GRPCErrorCodeUnavailable = 14, |
| 56 | GRPCErrorCodeDataLoss = 15 |
| 57 | }; |
| 58 | |
| 59 | // TODO(jcanizales): This is conflating trailing metadata with Status details. Fix it once there's |
| 60 | // a decision on how to codify Status. |
| 61 | #include <grpc/status.h> |
| 62 | struct grpc_metadata; |
| 63 | struct grpc_status { |
| 64 | grpc_status_code status; |
| 65 | const char *details; |
| 66 | size_t metadata_count; |
| 67 | struct grpc_metadata *metadata_elements; |
| 68 | }; |
| 69 | |
| 70 | @interface NSError (GRPC) |
| 71 | // Returns nil if the status is OK. Otherwise, a NSError whose code is one of |
| 72 | // GRPCErrorCode and whose domain is kGRPCErrorDomain. |
| 73 | + (instancetype)grpc_errorFromStatus:(struct grpc_status *)status; |
| 74 | @end |