blob: 0919a0c8bb783c808496862b25564c3aad3b925e [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
2 * Copyright 2018-present Open Networking Foundation
3
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7
8 * http://www.apache.org/licenses/LICENSE-2.0
9
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package kafka
17
18import (
19 "time"
20
serkant.uluderyab38671c2019-11-01 09:35:38 -070021 ca "github.com/opencord/voltha-protos/v3/go/inter_container"
Scott Baker2c1c4822019-10-16 11:02:41 -070022)
23
24const (
25 PartitionConsumer = iota
26 GroupCustomer = iota
27)
28
29const (
30 OffsetNewest = -1
31 OffsetOldest = -2
32)
33
34const (
35 GroupIdKey = "groupId"
36 Offset = "offset"
37)
38
39const (
40 DefaultKafkaHost = "127.0.0.1"
41 DefaultKafkaPort = 9092
42 DefaultGroupName = "voltha"
43 DefaultSleepOnError = 1
44 DefaultProducerFlushFrequency = 10
45 DefaultProducerFlushMessages = 10
46 DefaultProducerFlushMaxmessages = 100
47 DefaultProducerReturnSuccess = true
48 DefaultProducerReturnErrors = true
49 DefaultProducerRetryMax = 3
50 DefaultProducerRetryBackoff = time.Millisecond * 100
51 DefaultConsumerMaxwait = 100
52 DefaultMaxProcessingTime = 100
53 DefaultConsumerType = PartitionConsumer
54 DefaultNumberPartitions = 3
55 DefaultNumberReplicas = 1
56 DefaultAutoCreateTopic = false
57 DefaultMetadataMaxRetry = 3
Scott Baker104b67d2019-10-29 15:56:27 -070058 DefaultLivenessChannelInterval = time.Second * 30
Scott Baker2c1c4822019-10-16 11:02:41 -070059)
60
61// MsgClient represents the set of APIs a Kafka MsgClient must implement
62type Client interface {
63 Start() error
64 Stop()
65 CreateTopic(topic *Topic, numPartition int, repFactor int) error
66 DeleteTopic(topic *Topic) error
67 Subscribe(topic *Topic, kvArgs ...*KVArg) (<-chan *ca.InterContainerMessage, error)
68 UnSubscribe(topic *Topic, ch <-chan *ca.InterContainerMessage) error
Scott Baker84a55ce2020-04-17 10:11:30 -070069 SubscribeForMetadata(func(fromTopic string, timestamp time.Time))
Scott Baker2c1c4822019-10-16 11:02:41 -070070 Send(msg interface{}, topic *Topic, keys ...string) error
Scott Baker104b67d2019-10-29 15:56:27 -070071 SendLiveness() error
72 EnableLivenessChannel(enable bool) chan bool
Scott Baker0fef6982019-12-12 09:49:42 -080073 EnableHealthinessChannel(enable bool) chan bool
Scott Baker2c1c4822019-10-16 11:02:41 -070074}