Skip to content

Commit

Permalink
Addressed comments by jcanizales
Browse files Browse the repository at this point in the history
  • Loading branch information
@a11r
a11r committed Feb 3, 2016
1 parent 516d26e commit 80410eb
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions doc/statuscodes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,31 @@ gRPC uses a set of well defined status codes as part of the RPC API. All RPCs st
The gRPC client and server-side implementations may also generate and return `status` on their own when errors happen.
Only a subset of the pre-defined status codes are generated by the gRPC libraries. The following table lists these codes and summarizes the situations in which they are generated, either by the client or the server-side library implementation.

| Case | Code | Generated at Client or server |
| Case | Code | Generated at Client or Server |
| ------------- |:-------------| :-----:|
| Client Application cancelled the request | GRPC_STATUS_CANCELLED | Both |
| Deadline expires before server returns status | GRPC_STATUS_DEADLINE_EXCEEDED | Both |
| Method not found at server | GRPC_STATUS_UNIMPLEMENTED | Server|
| Server shutting down | GRPC_STATUS_UNAVAILABLE | Server|
| Server side application throws an exception (or does something other than returning a Status code to terminate an RPC) | GRPC_STATUS_UNKNOWN | Server|
| No response received before Deadline expires. This may occur either when the client is unable to send the request to the server or when the server fails to respond in time. | GRPC_STATUS_DEADLINE_EXCEEDED | Both|
| Some data transmitted (e.g., request metadata written to TCP connection) before connection breaks | GRPC_STATUS_UNAVAILABLE | Client |
| Could not decompress, but compression algorithm supported (Client -> Server) | GRPC_STATUS_INTERNAL | Server |
| Could not decompress, but compression algorithm supported (Server -> Client) | GRPC_STATUS_INTERNAL | Client |
| Compression mechanism used by client not supported at server | GRPC_STATUS_UNIMPLEMENTED | Server |
| Server temporarily out of resources (e.g., Flow-control resource limits reached) | GRPC_STATUS_RESOURCE_EXHAUSTED | Server|
| Flow-control protocol violation | GRPC_STATUS_INTERNAL | Both |
| Error parsing returned status | GRPC_STATUS_UNKNOWN | Client |
| Incorrect Auth metadata ( Credentials failed to get metadata, Incompatible credentials set on channel and call, Invalid host set in `:authority` metadata, etc.) | GRPC_STATUS_UNAUTHENTICATED | Both |
| Error parsing response proto | GRPC_STATUS_INTERNAL | Client|
| Error parsing request proto | GRPC_STATUS_INTERNAL | Server|
| Client Application cancelled the request | CANCELLED | Both |
| Deadline expires before server returns status | DEADLINE_EXCEEDED | Both |
| Method not found at server | UNIMPLEMENTED | Server|
| Server shutting down | UNAVAILABLE | Server|
| Server side application throws an exception (or does something other than returning a Status code to terminate an RPC) | UNKNOWN | Server|
| No response received before Deadline expires. This may occur either when the client is unable to send the request to the server or when the server fails to respond in time. | DEADLINE_EXCEEDED | Both|
| Some data transmitted (e.g., request metadata written to TCP connection) before connection breaks | UNAVAILABLE | Client |
| Could not decompress, but compression algorithm supported (Client -> Server) | INTERNAL | Server |
| Could not decompress, but compression algorithm supported (Server -> Client) | INTERNAL | Client |
| Compression mechanism used by client not supported at server | UNIMPLEMENTED | Server |
| Server temporarily out of resources (e.g., Flow-control resource limits reached) | RESOURCE_EXHAUSTED | Server|
| Flow-control protocol violation | INTERNAL | Both |
| Error parsing returned status | UNKNOWN | Client |
| Incorrect Auth metadata ( Credentials failed to get metadata, Incompatible credentials set on channel and call, Invalid host set in `:authority` metadata, etc.) | UNAUTHENTICATED | Both |
| Error parsing response proto | INTERNAL | Client|
| Error parsing request proto | INTERNAL | Server|


The following status codes are never generated by the library:
- GRPC_STATUS_INVALID_ARGUMENT
- GRPC_STATUS_NOT_FOUND
- GRPC_STATUS_ALREADY_EXISTS
- GRPC_STATUS_FAILED_PRECONDITION
- GRPC_STATUS_ABORTED
- GRPC_STATUS_OUT_OF_RANGE
- GRPC_STATUS_DATA_LOSS
- INVALID_ARGUMENT
- NOT_FOUND
- ALREADY_EXISTS
- FAILED_PRECONDITION
- ABORTED
- OUT_OF_RANGE
- DATA_LOSS

0 comments on commit 80410eb

Please sign in to comment.