-
Notifications
You must be signed in to change notification settings - Fork 808
/
streaming.go
77 lines (70 loc) · 2.55 KB
/
streaming.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
/*
* Copyright 2021 CloudWeGo Authors
*
* 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 streaming interface
package streaming
import (
"context"
"io"
"github.com/cloudwego/kitex/pkg/remote/trans/nphttp2/metadata"
)
// Stream both client and server stream
type Stream interface {
// SetHeader sets the header metadata. It may be called multiple times.
// When call multiple times, all the provided metadata will be merged.
// All the metadata will be sent out when one of the following happens:
// - ServerStream.SendHeader() is called;
// - The first response is sent out;
// - An RPC status is sent out (error or success).
SetHeader(metadata.MD) error
// SendHeader sends the header metadata.
// The provided md and headers set by SetHeader() will be sent.
// It fails if called multiple times.
SendHeader(metadata.MD) error
// SetTrailer sets the trailer metadata which will be sent with the RPC status.
// When called more than once, all the provided metadata will be merged.
SetTrailer(metadata.MD)
// Header is used for client side stream to receive header from server.
Header() (metadata.MD, error)
// Trailer is used for client side stream to receive trailer from server.
Trailer() metadata.MD
// Context the stream context.Context
Context() context.Context
// RecvMsg recvive message from peer
// will block until an error or a message received
// not concurrent-safety
RecvMsg(m interface{}) error
// SendMsg send message to peer
// will block until an error or enough buffer to send
// not concurrent-safety
SendMsg(m interface{}) error
// not concurrent-safety with SendMsg
io.Closer
}
// WithDoFinish should be implemented when:
// (1) you want to wrap a stream in client middleware, and
// (2) you want to manually call streaming.FinishStream(stream, error) to record the end of stream
// Note: the DoFinish should be reentrant, better with a sync.Once.
type WithDoFinish interface {
DoFinish(error)
}
// Args endpoint request
type Args struct {
Stream Stream
}
// Result endpoint response
type Result struct {
Stream Stream
}