-
Notifications
You must be signed in to change notification settings - Fork 19
/
request.go
63 lines (51 loc) · 1.94 KB
/
request.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
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package jsonrpc
import (
"errors"
)
var (
ErrOnlySupportJSONRPC2 = errors.New("the API only supports JSON-RPC 2.0")
ErrMethodIsRequired = errors.New("the method is required")
)
// Params is just a nicer way to describe what's passed to the handlers.
type Params interface{}
type Request struct {
// Version specifies the version of the JSON-RPC protocol.
// MUST be exactly "2.0".
Version string `json:"jsonrpc"`
// Method contains the name of the method to be invoked.
Method string `json:"method"`
// Params is a by-name Structured value that holds the parameter values to be
// used during the invocation of the method. This member MAY be omitted.
Params Params `json:"params,omitempty"`
// ID is an identifier established by the Client that MUST contain a String.
// If it is not included it is assumed to be a notification.
// The Server MUST reply with the same value in the Response object if included.
// This member is used to correlate the context between the two objects.
ID string `json:"id,omitempty"`
}
func (r *Request) Check() error {
if r.Version != VERSION2 {
return ErrOnlySupportJSONRPC2
}
if r.Method == "" {
return ErrMethodIsRequired
}
return nil
}
func (r *Request) IsNotification() bool {
return r.ID == ""
}