This repository has been archived by the owner on Oct 17, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
types.go
140 lines (106 loc) · 4.34 KB
/
types.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
// Copyright (c) 2018 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 consumer
import (
"net"
"time"
"github.com/m3db/m3msg/protocol/proto"
"github.com/m3db/m3x/instrument"
"github.com/m3db/m3x/pool"
"github.com/m3db/m3x/server"
)
// Message carries the data that needs to be processed.
type Message interface {
// Bytes returns the bytes.
Bytes() []byte
// Ack acks the message.
Ack()
}
// Consumer receives messages from a connection.
type Consumer interface {
// Message waits for and returns the next message received.
Message() (Message, error)
// Init initializes the consumer.
Init()
// Close closes the consumer.
Close()
}
// Listener is a consumer listener based on a network address.
type Listener interface {
// Accept waits for and returns the next connection based consumer.
Accept() (Consumer, error)
// Close closes the listener.
// Any blocked Accept operations will be unblocked and return errors.
Close() error
// Addr returns the listener's network address.
Addr() net.Addr
}
// Options configs the consumer listener.
type Options interface {
// EncoderOptions returns the options for Encoder.
EncoderOptions() proto.Options
// SetEncoderOptions sets the options for Encoder.
SetEncoderOptions(value proto.Options) Options
// DecoderOptions returns the options for Decoder.
DecoderOptions() proto.Options
// SetDecoderOptions sets the options for Decoder.
SetDecoderOptions(value proto.Options) Options
// MessagePoolOptions returns the options for message pool.
MessagePoolOptions() pool.ObjectPoolOptions
// SetMessagePoolOptions sets the options for message pool.
SetMessagePoolOptions(value pool.ObjectPoolOptions) Options
// AckFlushInterval returns the ack flush interval.
AckFlushInterval() time.Duration
// SetAckFlushInterval sets the ack flush interval.
SetAckFlushInterval(value time.Duration) Options
// AckBufferSize returns the ack buffer size.
AckBufferSize() int
// SetAckBufferSize sets the ack buffer size.
SetAckBufferSize(value int) Options
// ConnectionWriteBufferSize returns the size of buffer before a write or a read.
ConnectionWriteBufferSize() int
// SetConnectionWriteBufferSize sets the buffer size.
SetConnectionWriteBufferSize(value int) Options
// ConnectionReadBufferSize returns the size of buffer before a write or a read.
ConnectionReadBufferSize() int
// SetConnectionWriteBufferSize sets the buffer size.
SetConnectionReadBufferSize(value int) Options
// InstrumentOptions returns the instrument options.
InstrumentOptions() instrument.Options
// SetInstrumentOptions sets the instrument options.
SetInstrumentOptions(value instrument.Options) Options
}
// ConsumeFn processes the consumer.
type ConsumeFn func(c Consumer)
// ServerOptions configs the consumer server.
type ServerOptions interface {
// ConsumeFn returns the ConsumeFn.
ConsumeFn() ConsumeFn
// SetConsumeFn sets the ConsumeFn.
SetConsumeFn(value ConsumeFn) ServerOptions
// RetryOptions returns the options for connection retrier.
ServerOptions() server.Options
// SetRetryOptions sets the options for connection retrier.
SetServerOptions(value server.Options) ServerOptions
// InstrumentOptions returns the instrument options.
ConsumerOptions() Options
// SetInstrumentOptions sets the instrument options.
SetConsumerOptions(value Options) ServerOptions
}