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
|
// Copyright (c) 2020 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 core
import (
"context"
"errors"
"fmt"
"reflect"
"sync"
"sync/atomic"
"time"
"git.fd.io/govpp.git/api"
)
type Stream struct {
id uint32
conn *Connection
ctx context.Context
channel *Channel
// available options
requestSize int
replySize int
replyTimeout time.Duration
// per-request context
pkgPath string
sync.Mutex
}
func (c *Connection) NewStream(ctx context.Context, options ...api.StreamOption) (api.Stream, error) {
if c == nil {
return nil, errors.New("nil connection passed in")
}
s := &Stream{
conn: c,
ctx: ctx,
// default options
requestSize: RequestChanBufSize,
replySize: ReplyChanBufSize,
replyTimeout: DefaultReplyTimeout,
}
// parse custom options
for _, option := range options {
option(s)
}
// create and store a new channel
s.id = atomic.AddUint32(&c.maxChannelID, 1) & 0x7fff
s.channel = newChannel(uint16(s.id), c, c.codec, c, s.requestSize, s.replySize)
s.channel.SetReplyTimeout(s.replyTimeout)
// store API channel within the client
c.channelsLock.Lock()
c.channels[uint16(s.id)] = s.channel
c.channelsLock.Unlock()
// Channel.watchRequests are not started here intentionally, because
// requests are sent directly by SendMsg.
return s, nil
}
func (c *Connection) Invoke(ctx context.Context, req api.Message, reply api.Message) error {
stream, err := c.NewStream(ctx)
if err != nil {
return err
}
if err := stream.SendMsg(req); err != nil {
return err
}
s := stream.(*Stream)
rep, err := s.recvReply()
if err != nil {
return err
}
if err := s.channel.msgCodec.DecodeMsg(rep.data, reply); err != nil {
return err
}
return nil
}
func (s *Stream) Context() context.Context {
return s.ctx
}
func (s *Stream) Close() error {
if s.conn == nil {
return errors.New("stream closed")
}
s.conn.releaseAPIChannel(s.channel)
s.conn = nil
return nil
}
func (s *Stream) SendMsg(msg api.Message) error {
if s.conn == nil {
return errors.New("stream closed")
}
req := s.channel.newRequest(msg, false)
if err := s.conn.processRequest(s.channel, req); err != nil {
return err
}
s.Lock()
s.pkgPath = s.conn.GetMessagePath(msg)
s.Unlock()
return nil
}
func (s *Stream) RecvMsg() (api.Message, error) {
reply, err := s.recvReply()
if err != nil {
return nil, err
}
// resolve message type
s.Lock()
path := s.pkgPath
s.Unlock()
msg, err := s.channel.msgIdentifier.LookupByID(path, reply.msgID)
if err != nil {
return nil, err
}
// allocate message instance
msg = reflect.New(reflect.TypeOf(msg).Elem()).Interface().(api.Message)
// decode message data
if err := s.channel.msgCodec.DecodeMsg(reply.data, msg); err != nil {
return nil, err
}
return msg, nil
}
func WithRequestSize(size int) api.StreamOption {
return func(stream api.Stream) {
stream.(*Stream).requestSize = size
}
}
func WithReplySize(size int) api.StreamOption {
return func(stream api.Stream) {
stream.(*Stream).replySize = size
}
}
func WithReplyTimeout(timeout time.Duration) api.StreamOption {
return func(stream api.Stream) {
stream.(*Stream).replyTimeout = timeout
}
}
func (s *Stream) recvReply() (*vppReply, error) {
if s.conn == nil {
return nil, errors.New("stream closed")
}
select {
case reply, ok := <-s.channel.replyChan:
if !ok {
return nil, fmt.Errorf("reply channel closed")
}
if reply.err != nil {
// this case should actually never happen for stream
// since reply.err is only filled in watchRequests
// and stream does not use it
return nil, reply.err
}
return reply, nil
case <-s.ctx.Done():
return nil, s.ctx.Err()
}
}
|
