mirror of
https://gitee.com/milvus-io/milvus.git
synced 2024-12-02 03:48:37 +08:00
65 lines
2.0 KiB
Go
65 lines
2.0 KiB
Go
// Licensed to the LF AI & Data foundation under one
|
|
// or more contributor license agreements. See the NOTICE file
|
|
// distributed with this work for additional information
|
|
// regarding copyright ownership. The ASF licenses this file
|
|
// to you 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 mqwrapper
|
|
|
|
import "github.com/milvus-io/milvus/pkg/mq/common"
|
|
|
|
const DefaultPartitionIdx = 0
|
|
|
|
// UniqueID is the type of message id
|
|
type UniqueID = int64
|
|
|
|
// ConsumerOptions contains the options of a consumer
|
|
type ConsumerOptions struct {
|
|
// The topic that this consumer will subscribe on
|
|
Topic string
|
|
|
|
// The subscription name for this consumer
|
|
SubscriptionName string
|
|
|
|
// InitialPosition at which the cursor will be set when subscribe
|
|
// Default is `Latest`
|
|
common.SubscriptionInitialPosition
|
|
|
|
// Set receive channel size
|
|
BufSize int64
|
|
}
|
|
|
|
// Consumer is the interface that provides operations of a consumer
|
|
type Consumer interface {
|
|
// returns the subscription for the consumer
|
|
Subscription() string
|
|
|
|
// Get Message channel, once you chan you can not seek again
|
|
Chan() <-chan common.Message
|
|
|
|
// Seek to the uniqueID position, the second bool param indicates whether the message is included in the position
|
|
Seek(common.MessageID, bool) error //nolint:govet
|
|
|
|
// Ack make sure that msg is received
|
|
Ack(common.Message)
|
|
|
|
// Close consumer
|
|
Close()
|
|
|
|
// GetLatestMsgID return the latest message ID
|
|
GetLatestMsgID() (common.MessageID, error)
|
|
|
|
// check created topic whether vaild or not
|
|
CheckTopicValid(channel string) error
|
|
}
|