-
Notifications
You must be signed in to change notification settings - Fork 8
/
appcycle.vdl.go
397 lines (350 loc) · 11.9 KB
/
appcycle.vdl.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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// This file was auto-generated by the vanadium vdl tool.
// Package: appcycle
// Package appcycle defines interfaces for managing application processes.
package appcycle
import (
"io"
"v.io/v23"
"v.io/v23/context"
"v.io/v23/rpc"
"v.io/v23/vdl"
)
var _ = __VDLInit() // Must be first; see __VDLInit comments for details.
//////////////////////////////////////////////////
// Type definitions
// Task is streamed by Stop to provide the client with a sense of the progress
// of the shutdown.
// The meaning of Progress and Goal are up to the developer (the server provides
// the framework with values for these). The recommended meanings are:
// - Progress: how far along the shutdown sequence the server is. This should
// be a monotonically increasing number.
// - Goal: when Progress reaches this value, the shutdown is expected to
// complete. This should not change during a stream, but could change if
// e.g. new shutdown tasks are triggered that were not forseen at the outset
// of the shutdown.
type Task struct {
Progress int32
Goal int32
}
func (Task) VDLReflect(struct {
Name string `vdl:"v.io/v23/services/appcycle.Task"`
}) {
}
func (x Task) VDLIsZero() bool {
return x == Task{}
}
func (x Task) VDLWrite(enc vdl.Encoder) error {
if err := enc.StartValue(__VDLType_struct_1); err != nil {
return err
}
if x.Progress != 0 {
if err := enc.NextFieldValueInt(0, vdl.Int32Type, int64(x.Progress)); err != nil {
return err
}
}
if x.Goal != 0 {
if err := enc.NextFieldValueInt(1, vdl.Int32Type, int64(x.Goal)); err != nil {
return err
}
}
if err := enc.NextField(-1); err != nil {
return err
}
return enc.FinishValue()
}
func (x *Task) VDLRead(dec vdl.Decoder) error {
*x = Task{}
if err := dec.StartValue(__VDLType_struct_1); err != nil {
return err
}
decType := dec.Type()
for {
index, err := dec.NextField()
switch {
case err != nil:
return err
case index == -1:
return dec.FinishValue()
}
if decType != __VDLType_struct_1 {
index = __VDLType_struct_1.FieldIndexByName(decType.Field(index).Name)
if index == -1 {
if err := dec.SkipValue(); err != nil {
return err
}
continue
}
}
switch index {
case 0:
switch value, err := dec.ReadValueInt(32); {
case err != nil:
return err
default:
x.Progress = int32(value)
}
case 1:
switch value, err := dec.ReadValueInt(32); {
case err != nil:
return err
default:
x.Goal = int32(value)
}
}
}
}
//////////////////////////////////////////////////
// Interface definitions
// AppCycleClientMethods is the client interface
// containing AppCycle methods.
//
// AppCycle interfaces with the process running a vanadium runtime.
type AppCycleClientMethods interface {
// Stop initiates shutdown of the server. It streams back periodic
// updates to give the client an idea of how the shutdown is
// progressing.
Stop(*context.T, ...rpc.CallOpt) (AppCycleStopClientCall, error)
// ForceStop tells the server to shut down right away. It can be issued
// while a Stop is outstanding if for example the client does not want
// to wait any longer.
ForceStop(*context.T, ...rpc.CallOpt) error
}
// AppCycleClientStub adds universal methods to AppCycleClientMethods.
type AppCycleClientStub interface {
AppCycleClientMethods
rpc.UniversalServiceMethods
}
// AppCycleClient returns a client stub for AppCycle.
func AppCycleClient(name string) AppCycleClientStub {
return implAppCycleClientStub{name}
}
type implAppCycleClientStub struct {
name string
}
func (c implAppCycleClientStub) Stop(ctx *context.T, opts ...rpc.CallOpt) (ocall AppCycleStopClientCall, err error) {
var call rpc.ClientCall
if call, err = v23.GetClient(ctx).StartCall(ctx, c.name, "Stop", nil, opts...); err != nil {
return
}
ocall = &implAppCycleStopClientCall{ClientCall: call}
return
}
func (c implAppCycleClientStub) ForceStop(ctx *context.T, opts ...rpc.CallOpt) (err error) {
err = v23.GetClient(ctx).Call(ctx, c.name, "ForceStop", nil, nil, opts...)
return
}
// AppCycleStopClientStream is the client stream for AppCycle.Stop.
type AppCycleStopClientStream interface {
// RecvStream returns the receiver side of the AppCycle.Stop client stream.
RecvStream() interface {
// Advance stages an item so that it may be retrieved via Value. Returns
// true iff there is an item to retrieve. Advance must be called before
// Value is called. May block if an item is not available.
Advance() bool
// Value returns the item that was staged by Advance. May panic if Advance
// returned false or was not called. Never blocks.
Value() Task
// Err returns any error encountered by Advance. Never blocks.
Err() error
}
}
// AppCycleStopClientCall represents the call returned from AppCycle.Stop.
type AppCycleStopClientCall interface {
AppCycleStopClientStream
// Finish blocks until the server is done, and returns the positional return
// values for call.
//
// Finish returns immediately if the call has been canceled; depending on the
// timing the output could either be an error signaling cancelation, or the
// valid positional return values from the server.
//
// Calling Finish is mandatory for releasing stream resources, unless the call
// has been canceled or any of the other methods return an error. Finish should
// be called at most once.
Finish() error
}
type implAppCycleStopClientCall struct {
rpc.ClientCall
valRecv Task
errRecv error
}
func (c *implAppCycleStopClientCall) RecvStream() interface {
Advance() bool
Value() Task
Err() error
} {
return implAppCycleStopClientCallRecv{c}
}
type implAppCycleStopClientCallRecv struct {
c *implAppCycleStopClientCall
}
func (c implAppCycleStopClientCallRecv) Advance() bool {
c.c.valRecv = Task{}
c.c.errRecv = c.c.Recv(&c.c.valRecv)
return c.c.errRecv == nil
}
func (c implAppCycleStopClientCallRecv) Value() Task {
return c.c.valRecv
}
func (c implAppCycleStopClientCallRecv) Err() error {
if c.c.errRecv == io.EOF {
return nil
}
return c.c.errRecv
}
func (c *implAppCycleStopClientCall) Finish() (err error) {
err = c.ClientCall.Finish()
return
}
// AppCycleServerMethods is the interface a server writer
// implements for AppCycle.
//
// AppCycle interfaces with the process running a vanadium runtime.
type AppCycleServerMethods interface {
// Stop initiates shutdown of the server. It streams back periodic
// updates to give the client an idea of how the shutdown is
// progressing.
Stop(*context.T, AppCycleStopServerCall) error
// ForceStop tells the server to shut down right away. It can be issued
// while a Stop is outstanding if for example the client does not want
// to wait any longer.
ForceStop(*context.T, rpc.ServerCall) error
}
// AppCycleServerStubMethods is the server interface containing
// AppCycle methods, as expected by rpc.Server.
// The only difference between this interface and AppCycleServerMethods
// is the streaming methods.
type AppCycleServerStubMethods interface {
// Stop initiates shutdown of the server. It streams back periodic
// updates to give the client an idea of how the shutdown is
// progressing.
Stop(*context.T, *AppCycleStopServerCallStub) error
// ForceStop tells the server to shut down right away. It can be issued
// while a Stop is outstanding if for example the client does not want
// to wait any longer.
ForceStop(*context.T, rpc.ServerCall) error
}
// AppCycleServerStub adds universal methods to AppCycleServerStubMethods.
type AppCycleServerStub interface {
AppCycleServerStubMethods
// Describe the AppCycle interfaces.
Describe__() []rpc.InterfaceDesc
}
// AppCycleServer returns a server stub for AppCycle.
// It converts an implementation of AppCycleServerMethods into
// an object that may be used by rpc.Server.
func AppCycleServer(impl AppCycleServerMethods) AppCycleServerStub {
stub := implAppCycleServerStub{
impl: impl,
}
// Initialize GlobState; always check the stub itself first, to handle the
// case where the user has the Glob method defined in their VDL source.
if gs := rpc.NewGlobState(stub); gs != nil {
stub.gs = gs
} else if gs := rpc.NewGlobState(impl); gs != nil {
stub.gs = gs
}
return stub
}
type implAppCycleServerStub struct {
impl AppCycleServerMethods
gs *rpc.GlobState
}
func (s implAppCycleServerStub) Stop(ctx *context.T, call *AppCycleStopServerCallStub) error {
return s.impl.Stop(ctx, call)
}
func (s implAppCycleServerStub) ForceStop(ctx *context.T, call rpc.ServerCall) error {
return s.impl.ForceStop(ctx, call)
}
func (s implAppCycleServerStub) Globber() *rpc.GlobState {
return s.gs
}
func (s implAppCycleServerStub) Describe__() []rpc.InterfaceDesc {
return []rpc.InterfaceDesc{AppCycleDesc}
}
// AppCycleDesc describes the AppCycle interface.
var AppCycleDesc rpc.InterfaceDesc = descAppCycle
// descAppCycle hides the desc to keep godoc clean.
var descAppCycle = rpc.InterfaceDesc{
Name: "AppCycle",
PkgPath: "v.io/v23/services/appcycle",
Doc: "// AppCycle interfaces with the process running a vanadium runtime.",
Methods: []rpc.MethodDesc{
{
Name: "Stop",
Doc: "// Stop initiates shutdown of the server. It streams back periodic\n// updates to give the client an idea of how the shutdown is\n// progressing.",
},
{
Name: "ForceStop",
Doc: "// ForceStop tells the server to shut down right away. It can be issued\n// while a Stop is outstanding if for example the client does not want\n// to wait any longer.",
},
},
}
// AppCycleStopServerStream is the server stream for AppCycle.Stop.
type AppCycleStopServerStream interface {
// SendStream returns the send side of the AppCycle.Stop server stream.
SendStream() interface {
// Send places the item onto the output stream. Returns errors encountered
// while sending. Blocks if there is no buffer space; will unblock when
// buffer space is available.
Send(item Task) error
}
}
// AppCycleStopServerCall represents the context passed to AppCycle.Stop.
type AppCycleStopServerCall interface {
rpc.ServerCall
AppCycleStopServerStream
}
// AppCycleStopServerCallStub is a wrapper that converts rpc.StreamServerCall into
// a typesafe stub that implements AppCycleStopServerCall.
type AppCycleStopServerCallStub struct {
rpc.StreamServerCall
}
// Init initializes AppCycleStopServerCallStub from rpc.StreamServerCall.
func (s *AppCycleStopServerCallStub) Init(call rpc.StreamServerCall) {
s.StreamServerCall = call
}
// SendStream returns the send side of the AppCycle.Stop server stream.
func (s *AppCycleStopServerCallStub) SendStream() interface {
Send(item Task) error
} {
return implAppCycleStopServerCallSend{s}
}
type implAppCycleStopServerCallSend struct {
s *AppCycleStopServerCallStub
}
func (s implAppCycleStopServerCallSend) Send(item Task) error {
return s.s.Send(item)
}
// Hold type definitions in package-level variables, for better performance.
var (
__VDLType_struct_1 *vdl.Type
)
var __VDLInitCalled bool
// __VDLInit performs vdl initialization. It is safe to call multiple times.
// If you have an init ordering issue, just insert the following line verbatim
// into your source files in this package, right after the "package foo" clause:
//
// var _ = __VDLInit()
//
// The purpose of this function is to ensure that vdl initialization occurs in
// the right order, and very early in the init sequence. In particular, vdl
// registration and package variable initialization needs to occur before
// functions like vdl.TypeOf will work properly.
//
// This function returns a dummy value, so that it can be used to initialize the
// first var in the file, to take advantage of Go's defined init order.
func __VDLInit() struct{} {
if __VDLInitCalled {
return struct{}{}
}
__VDLInitCalled = true
// Register types.
vdl.Register((*Task)(nil))
// Initialize type definitions.
__VDLType_struct_1 = vdl.TypeOf((*Task)(nil)).Elem()
return struct{}{}
}