Documentation
¶
Overview ¶
Licensed to the Apache Software Foundation (ASF) 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.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Producer ¶
type Producer interface {
Start() error
Shutdown() error
SendSync(ctx context.Context, mq ...*primitive.Message) (*primitive.SendResult, error)
SendAsync(ctx context.Context, mq func(ctx context.Context, result *primitive.SendResult, err error),
msg ...*primitive.Message) error
SendOneWay(ctx context.Context, mq ...*primitive.Message) error
Request(ctx context.Context, ttl time.Duration, msg *primitive.Message) (*primitive.Message, error)
RequestAsync(ctx context.Context, ttl time.Duration, callback internal.RequestCallback, msg *primitive.Message) error
}
type PullConsumer ¶
type PullConsumer interface {
// Start the PullConsumer for consuming message
Start() error
// Subscribe a topic for consuming
Subscribe(topic string, selector consumer.MessageSelector) error
// Unsubscribe a topic
Unsubscribe(topic string) error
// Shutdown the PullConsumer, all offset of MessageQueue will be commit to broker before process exit
Shutdown() error
// Poll messages with timeout.
Poll(ctx context.Context, timeout time.Duration) (*consumer.ConsumeRequest, error)
//ACK ACK
ACK(ctx context.Context, cr *consumer.ConsumeRequest, consumeResult consumer.ConsumeResult)
// Pull message of topic, selector indicate which queue to pull.
Pull(ctx context.Context, numbers int) (*primitive.PullResult, error)
// PullFrom pull messages of queue from the offset to offset + numbers
PullFrom(ctx context.Context, queue *primitive.MessageQueue, offset int64, numbers int) (*primitive.PullResult, error)
// UpdateOffset updateOffset update offset of queue in mem
UpdateOffset(queue *primitive.MessageQueue, offset int64) error
// PersistOffset persist all offset in mem.
PersistOffset(ctx context.Context, topic string) error
// CurrentOffset return the current offset of queue in mem.
CurrentOffset(queue *primitive.MessageQueue) (int64, error)
}
func NewPullConsumer ¶
func NewPullConsumer(opts ...consumer.Option) (PullConsumer, error)
type PushConsumer ¶
type PushConsumer interface {
// Start the PushConsumer for consuming message
Start() error
// Shutdown the PushConsumer, all offset of MessageQueue will be sync to broker before process exit
Shutdown() error
// Subscribe a topic for consuming
Subscribe(topic string, selector consumer.MessageSelector,
f func(context.Context, ...*primitive.MessageExt) (consumer.ConsumeResult, error)) error
// Unsubscribe a topic
Unsubscribe(topic string) error
// Suspend the consumption
Suspend()
// Resume the consumption
Resume()
// GetOffsetDiffMap Get offset difference map
GetOffsetDiffMap() map[string]int64
}
func NewPushConsumer ¶
func NewPushConsumer(opts ...consumer.Option) (PushConsumer, error)
type TransactionProducer ¶
type TransactionProducer interface {
Start() error
Shutdown() error
SendMessageInTransaction(ctx context.Context, mq *primitive.Message) (*primitive.TransactionSendResult, error)
}
func NewTransactionProducer ¶
func NewTransactionProducer(listener primitive.TransactionListener, opts ...producer.Option) (TransactionProducer, error)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package consumer is a generated GoMock package.
|
Package consumer is a generated GoMock package. |
|
examples
|
|
|
admin/group
command
|
|
|
admin/topic
command
|
|
|
consumer/acl
command
|
|
|
consumer/broadcast
command
|
|
|
consumer/delay
command
|
|
|
consumer/interceptor
command
|
|
|
consumer/namespace
command
|
|
|
consumer/orderly
command
|
|
|
consumer/pull/poll
command
|
|
|
consumer/pull/pull
command
|
|
|
consumer/pull/pull_from
command
|
|
|
consumer/retry/concurrent
command
|
|
|
consumer/retry/order
command
*
|
* |
|
consumer/rpc
command
|
|
|
consumer/simple
command
|
|
|
consumer/strategy
command
|
|
|
consumer/tag
command
|
|
|
consumer/trace
command
|
|
|
producer/acl
command
Package main implements a producer with user custom interceptor.
|
Package main implements a producer with user custom interceptor. |
|
producer/async
command
|
|
|
producer/batch
command
|
|
|
producer/delay
command
|
|
|
producer/interceptor
command
Package main implements a producer with user custom interceptor.
|
Package main implements a producer with user custom interceptor. |
|
producer/namespace
command
Package main implements a producer with user custom interceptor.
|
Package main implements a producer with user custom interceptor. |
|
producer/rpc/async
command
|
|
|
producer/rpc/sync
command
|
|
|
producer/simple
command
|
|
|
producer/tag
command
|
|
|
producer/trace
command
|
|
|
producer/transaction
command
|
|
|
Package internal is a generated GoMock package.
|
Package internal is a generated GoMock package. |
|
remote
* Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements.
|
* Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. |
|
* Define the ctx key and value type.
|
* Define the ctx key and value type. |
|
*
|
* |