-
Notifications
You must be signed in to change notification settings - Fork 100
/
register.go
157 lines (130 loc) · 4.88 KB
/
register.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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package transport
import (
"context"
"sort"
"go.uber.org/yarpc/internal/errors"
)
// TODO: Until golang/mock#4 is fixed, imports in the generated code have to
// be fixed by hand. They use vendor/* import paths rather than direct.
//go:generate mockgen -destination=transporttest/register.go -package=transporttest go.uber.org/yarpc/transport UnaryHandler,Registry
// ServiceProcedure represents a service and procedure registered against a
// Registry.
type ServiceProcedure struct {
Service string
Procedure string
}
// Registrant specifies a single handler registered against the registry.
type Registrant struct {
// Service name or empty to use the default service name.
Service string
// Name of the procedure.
Procedure string
// HandlerSpec specifiying which handler and rpc type.
HandlerSpec HandlerSpec
}
// Registry maintains and provides access to a collection of procedures and
// their handlers.
type Registry interface {
// ServiceProcedures returns a list of services and their procedures that
// have been registered so far.
ServiceProcedures() []ServiceProcedure
// Choose decides a handler based on a context and transport request
// metadata, or returns an UnrecognizedProcedureError if no handler exists
// for the request. This is the interface for use in inbound transports to
// select a handler for a request.
Choose(ctx context.Context, req *Request) (HandlerSpec, error)
}
// Registrar provides access to a collection of procedures and their handlers.
type Registrar interface {
Registry
// Registers zero or more registrants with the registry.
Register([]Registrant)
}
// MapRegistry is a Registry that maintains a map of the registered
// procedures.
type MapRegistry struct {
defaultService string
entries map[ServiceProcedure]HandlerSpec
}
// NewMapRegistry builds a new MapRegistry that uses the given name as the
// default service name.
func NewMapRegistry(defaultService string) MapRegistry {
return MapRegistry{
defaultService: defaultService,
entries: make(map[ServiceProcedure]HandlerSpec),
}
}
// Register registers the procedure with the MapRegistry.
func (m MapRegistry) Register(rs []Registrant) {
for _, r := range rs {
if r.Service == "" {
r.Service = m.defaultService
}
if r.Procedure == "" {
panic("Expected procedure name not to be empty string in registration")
}
sp := ServiceProcedure{r.Service, r.Procedure}
m.entries[sp] = r.HandlerSpec
}
}
// ServiceProcedures returns a list of services and their procedures that
// have been registered so far.
func (m MapRegistry) ServiceProcedures() []ServiceProcedure {
procs := make([]ServiceProcedure, 0, len(m.entries))
for k := range m.entries {
procs = append(procs, k)
}
sort.Sort(byServiceProcedure(procs))
return procs
}
// ChooseProcedure retrieves the HandlerSpec for the given Procedure or returns an
// error.
func (m MapRegistry) ChooseProcedure(service, procedure string) (HandlerSpec, error) {
if service == "" {
service = m.defaultService
}
if spec, ok := m.entries[ServiceProcedure{service, procedure}]; ok {
return spec, nil
}
return HandlerSpec{}, errors.UnrecognizedProcedureError{
Service: service,
Procedure: procedure,
}
}
// Choose retrives the HandlerSpec for the service and procedure noted on the
// transport request, or returns an error.
func (m MapRegistry) Choose(ctx context.Context, req *Request) (HandlerSpec, error) {
return m.ChooseProcedure(req.Service, req.Procedure)
}
type byServiceProcedure []ServiceProcedure
func (sp byServiceProcedure) Len() int {
return len(sp)
}
func (sp byServiceProcedure) Less(i int, j int) bool {
if sp[i].Service == sp[j].Service {
return sp[i].Procedure < sp[j].Procedure
}
return sp[i].Service < sp[j].Service
}
func (sp byServiceProcedure) Swap(i int, j int) {
sp[i], sp[j] = sp[j], sp[i]
}