forked from ligato/vpp-agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client_api.go
58 lines (44 loc) · 1.71 KB
/
client_api.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
// Copyright (c) 2019 Cisco and/or its affiliates.
//
// 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.
package client
import (
"context"
"github.com/gogo/protobuf/proto"
api "github.com/ligato/vpp-agent/api/genericmanager"
)
type ModelInfo = api.ModelInfo
type StateItem = api.StateItem
// ConfigClient defines the client-side interface for config.
type ConfigClient interface {
// KnownModels retrieves list of known modules.
KnownModels() ([]ModelInfo, error)
// ChangeRequest returns transaction for changing config.
ChangeRequest() ChangeRequest
// ResyncConfig overwrites existing config.
ResyncConfig(items ...proto.Message) error
// GetConfig retrieves current config into dsts.
// TODO: return as list of config items
GetConfig(dsts ...interface{}) error
// DumpState dumps actual running state.
DumpState() ([]*StateItem, error)
}
// ChangeRequest is interface for config change request.
type ChangeRequest interface {
// Update appends updates for given items to the request.
Update(items ...proto.Message) ChangeRequest
// Delete appends deletes for given items to the request.
Delete(items ...proto.Message) ChangeRequest
// Send sends the request.
Send(ctx context.Context) error
}