forked from daos-stack/daos
-
Notifications
You must be signed in to change notification settings - Fork 0
/
failure.go
115 lines (101 loc) · 3.52 KB
/
failure.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
//
// (C) Copyright 2018-2019 Intel Corporation.
//
// 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.
//
// GOVERNMENT LICENSE RIGHTS-OPEN SOURCE SOFTWARE
// The Government's rights to use, modify, reproduce, release, perform, display,
// or disclose this software are subject to the terms of the Apache License as
// provided in Contract No. 8F-30005.
// Any reproduction of computer software, computer software documentation, or
// portions thereof marked with this legend must also reproduce the markings.
package drpc
// Failure represents a dRPC protocol failure.
type Failure struct {
statusCode Status
message string
}
// Error provides a descriptive string associated with the failure.
func (e Failure) Error() string {
return e.message
}
// GetStatus provides a dRPC status code associated with the failure.
func (e Failure) GetStatus() Status {
return e.statusCode
}
// NewFailure returns a Failure with the given status and a corresponding message.
func NewFailure(status Status) Failure {
message := statusToString(status)
return Failure{
message: message,
statusCode: status,
}
}
func statusToString(status Status) string {
switch status {
case Status_UNKNOWN_MODULE:
return "unrecognized module ID"
case Status_UNKNOWN_METHOD:
return "unrecognized method ID"
case Status_FAILED_UNMARSHAL_CALL:
return "failed to unmarshal incoming call"
case Status_FAILED_UNMARSHAL_PAYLOAD:
return "failed to unmarshal method-specific payload"
case Status_FAILED_MARSHAL:
return "failed to marshal response payload"
case Status_SUCCESS:
fallthrough
case Status_SUBMITTED:
return ""
}
return "an unknown error occurred"
}
// UnknownModuleFailure creates a Failure for unknown dRPC module.
func UnknownModuleFailure() Failure {
return NewFailure(Status_UNKNOWN_MODULE)
}
// UnknownMethodFailure creates a Failure for unknown dRPC method.
func UnknownMethodFailure() Failure {
return NewFailure(Status_UNKNOWN_METHOD)
}
// UnmarshalingCallFailure creates a Failure for a failed attempt to unmarshal an incoming call.
func UnmarshalingCallFailure() Failure {
return NewFailure(Status_FAILED_UNMARSHAL_CALL)
}
// UnmarshalingPayloadFailure creates a Failure for a failed attempt to unmarshal a call payload.
func UnmarshalingPayloadFailure() Failure {
return NewFailure(Status_FAILED_UNMARSHAL_PAYLOAD)
}
// MarshalingFailure creates a Failure for a failed attempt at marshaling a response.
func MarshalingFailure() Failure {
return NewFailure(Status_FAILED_MARSHAL)
}
// NewFailureWithMessage returns a generic failure with a custom message
func NewFailureWithMessage(message string) Failure {
return Failure{
message: message,
statusCode: Status_FAILURE,
}
}
// ErrorToStatus translates an error to a dRPC Status.
// In practice it checks to see if it was a dRPC Failure error, and uses the Status if so.
// Otherwise it is assumed to be a generic failure.
func ErrorToStatus(err error) Status {
if err == nil {
return Status_SUCCESS
}
if failure, ok := err.(Failure); ok {
return failure.GetStatus()
}
return Status_FAILURE
}