package
2.1.0
Repository: https://github.com/golang-tools/redishelper.git
Documentation: pkg.go.dev

# Functions

NewConsumer 创建一个指向多个流的消费者默认一批获取一个消息,可以通过`WithStreamComsumerRecvBatchSize`设置批的大小如果使用`WithStreamComsumerGroupName`设定了group,则按组消费(默认总组监听的最新位置开始监听,收到消息后确认,消息确认策略可以通过`WithStreamComsumerAckMode`配置),否则按按单独客户端消费(默认从开始监听的时刻开始消费)需要注意单独客户端消费不会记录消费的偏移量,因此很容易丢失下次请求时的结果.解决方法是第一次使用`$`,后面则需要记录下id号从它开始@params cli redis.UniversalClient redis客户端对象@params opts ...optparams.Option[pchelper.Options] 消费者的配置.
NewProducer 创建一个新的流生产者@params k *clientkey.ClientKey redis客户端的键对象@params opts ...broker.Option 生产者的配置.
NewStream 创建一个新的流对象@params cli redis.UniversalClient redis客户端的对象@params name string 流名.
SerializeWithJSON 使用JSON作为序列化反序列化的协议.
SerializeWithMsgpack 使用JSON作为序列化反序列化的协议.
WithAutocreate CreateGroup方法的参数,用于设置是否自动创建流.
WithBlockTime 设置客户端阻塞等待消息的时长.
WithClientID 中间件通用设置,设置客户端id.
WithConsumerAckMode stream消费者专用,用于设定同步校验规则.
WithConsumerDefaultStartAt stream消费者专用,用于设定默认消费起始时间.
WithConsumerDefaultStartEarliest stream消费者专用,用于设定默认消费从最早的消息开始.
WithConsumerDefaultStartLatest stream消费者专用,用于设定默认消费从最新的消息开始.
WithConsumerDefaultStartPosition stream消费者专用,用于设定默认消费起始位置,不设置则group设置为`$`,否则设置为`>`.
WithConsumerGroupName stream消费者专用,用于设定客户端组.
WithConsumerRecvBatchSize stream消费者专用,用于设定一次获取的消息批长度.
WithProducerDefaultMaxLen stream生产者专用,用于设置流的默认最长长度.
WithProducerStrict stream生产者专用,用于设置流是否为严格模式.
WithStartLatest CreateGroup方法的参数,用于设置创建流后流的默认读取位置为指定id.
WithStartEarliest CreateGroup方法的参数,用于设置创建流后流的默认读取位置为最早数据.
WithStartLatest CreateGroup方法的参数,用于设置创建流后流的默认读取位置为最新数据.
WithStrict Trim方法的参数,用于设置严格控制长度.
WithUUIDSnowflake 使用snowflake作为uuid的生成器.
WithUUIDSonyflake 使用sonyflake作为uuid的生成器.
WithUUIDv4 使用uuid4作为uuid的生成器.

# Constants

AckModeAckWhenDone 处理完后确认.
AckModeAckWhenGet 获取到后确认.
AckModeNoAck 不做确认,消费者需要自己实现ack操作,最好别这么用.

# Variables

ErrStreamConsumerAlreadyListened 流已经被监听了.
ErrStreamConsumerNotListeningYet 流未被监听.
ErrStreamNeedToPointOutGroups 流操作需要指定消费者组.

# Structs

Consumer 流消费者对象.
No description provided by the author
Producer 流的生产者对象.
Stream 流对象.

# Type aliases

AckModeType stream的Ack模式.