topicreaderinternal

package
v3.40.2-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2022 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrCommitDisabled = xerrors.Wrap(errors.New("ydb: commits disabled"))
View Source 
var (
	ErrReaderClosed = xerrors.Wrap(errors.New("ydb: reader closed"))
)
View Source 
var PublicErrUnexpectedCodec = errors.New("unexpected codec") //nolint:revive,stylecheck

PublicErrUnexpectedCodec return when try to read message content with unknown codec

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

Functions

This section is empty.

Types

type CallbackWithMessageContentFunc 

type CallbackWithMessageContentFunc func(data []byte) error

CallbackWithMessageContentFunc is callback function for work with message content data bytes MUST NOT be used after f returned if you need content longer - copy content to other slice

type CommitRanges 

type CommitRanges struct {
	// contains filtered or unexported fields
}

func NewCommitRangesFromPublicCommits 

func NewCommitRangesFromPublicCommits(ranges []PublicCommitRange) CommitRanges

func NewCommitRangesWithCapacity 

func NewCommitRangesWithCapacity(capacity int) CommitRanges

func (*CommitRanges) Append 

func (r *CommitRanges) Append(ranges ...PublicCommitRangeGetter)

func (*CommitRanges) AppendMessages 

func (r *CommitRanges) AppendMessages(messages ...PublicMessage)

func (*CommitRanges) PartitionIDs added in v3.32.0 

func (r *CommitRanges) PartitionIDs() []int64

PartitionIDs implements trace.TopicReaderStreamSendCommitMessageStartMessageInfo

func (*CommitRanges) PartitionSessionIDs added in v3.32.0 

func (r *CommitRanges) PartitionSessionIDs() []int64

PartitionSessionIDs implements trace.TopicReaderStreamSendCommitMessageStartMessageInfo

func (*CommitRanges) Reset 

func (r *CommitRanges) Reset()

type Pool 

type Pool interface {
	Get() interface{}
	Put(x interface{})
}

Pool is interface for sync.Pool and may be extended by follow to original type

type PublicBatch 

type PublicBatch struct {
	empty.DoNotCopy

	Messages []*PublicMessage
	// contains filtered or unexported fields
}

PublicBatch is ordered group of message from one partition

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (*PublicBatch) Context 

func (m *PublicBatch) Context() context.Context

Context is cancelled when code should stop to process messages batch for example - lost connection to server or receive stop partition signal without graceful flag

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (*PublicBatch) PartitionID 

func (m *PublicBatch) PartitionID() int64

PartitionID of messages in the batch

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (*PublicBatch) Topic 

func (m *PublicBatch) Topic() string

Topic is path of source topic of the messages in the batch

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicCommitMode 

type PublicCommitMode int

PublicCommitMode

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release. 

const (
	CommitModeAsync PublicCommitMode = iota // default
	CommitModeNone
	CommitModeSync
)

type PublicCommitRange 

type PublicCommitRange struct {
	// contains filtered or unexported fields
}

PublicCommitRange contains data for commit messages range

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicCommitRangeGetter 

type PublicCommitRangeGetter interface {
	// contains filtered or unexported methods
}

PublicCommitRangeGetter return data piece for commit messages range

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicCreateDecoderFunc 

type PublicCreateDecoderFunc func(input io.Reader) (io.Reader, error)

PublicCreateDecoderFunc

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicGetPartitionStartOffsetFunc 

type PublicGetPartitionStartOffsetFunc func(
	ctx context.Context,
	req PublicGetPartitionStartOffsetRequest,
) (res PublicGetPartitionStartOffsetResponse, err error)

PublicGetPartitionStartOffsetFunc

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicGetPartitionStartOffsetRequest 

type PublicGetPartitionStartOffsetRequest struct {
	Topic       string
	PartitionID int64
}

PublicGetPartitionStartOffsetRequest

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicGetPartitionStartOffsetResponse 

type PublicGetPartitionStartOffsetResponse struct {
	// contains filtered or unexported fields
}

PublicGetPartitionStartOffsetResponse

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (*PublicGetPartitionStartOffsetResponse) StartFrom 

func (r *PublicGetPartitionStartOffsetResponse) StartFrom(offset int64)

type PublicMessage 

type PublicMessage struct {
	empty.DoNotCopy

	SeqNo                int64
	CreatedAt            time.Time
	MessageGroupID       string
	WriteSessionMetadata map[string]string
	Offset               int64
	WrittenAt            time.Time
	ProducerID           string

	UncompressedSize int // as sent by sender, server/sdk doesn't check the field. It may be empty or wrong.
	// contains filtered or unexported fields
}

PublicMessage is representation of topic message

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (*PublicMessage) Context 

func (m *PublicMessage) Context() context.Context

func (*PublicMessage) PartitionID 

func (m *PublicMessage) PartitionID() int64

func (*PublicMessage) Read 

func (m *PublicMessage) Read(p []byte) (n int, err error)

Read implements io.Reader Read uncompressed message content return topicreader.UnexpectedCodec if message compressed with unknown codec

func (*PublicMessage) Topic 

func (m *PublicMessage) Topic() string

func (*PublicMessage) UnmarshalTo 

func (m *PublicMessage) UnmarshalTo(dst PublicMessageContentUnmarshaler) error

UnmarshalTo can call most once per message, it read all data from internal reader and call PublicMessageContentUnmarshaler.UnmarshalYDBTopicMessage with uncompressed content

type PublicMessageContentUnmarshaler 

type PublicMessageContentUnmarshaler interface {
	// UnmarshalYDBTopicMessage MUST NOT use data after return.
	// If you need content after return from Consume - copy data content to
	// own slice with copy(dst, data)
	//
	// Experimental
	//
	// Notice: This API is EXPERIMENTAL and may be changed or removed in a
	// later release.
	UnmarshalYDBTopicMessage(data []byte) error
}

PublicMessageContentUnmarshaler is interface for unmarshal message content

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicReadBatchOption 

type PublicReadBatchOption interface {
	Apply(options ReadMessageBatchOptions) ReadMessageBatchOptions
}

PublicReadBatchOption для различных пожеланий к батчу вроде WithMaxMessages(int)

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicReadSelector 

type PublicReadSelector struct {
	Path       string
	Partitions []int64
	ReadFrom   time.Time     // zero value mean skip read from filter
	MaxTimeLag time.Duration // 0 mean skip time lag filter
}

PublicReadSelector

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func (PublicReadSelector) Clone 

func (s PublicReadSelector) Clone() PublicReadSelector

Clone create deep clone of the selector

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

type PublicReaderOption 

type PublicReaderOption func(cfg *ReaderConfig)

PublicReaderOption

Experimental

Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.

func WithCredentials added in v3.37.8 

func WithCredentials(cred credentials.Credentials) PublicReaderOption

func WithTrace added in v3.38.0 

func WithTrace(tracer trace.Topic) PublicReaderOption

type RawTopicReaderStream 

type RawTopicReaderStream interface {
	Recv() (rawtopicreader.ServerMessage, error)
	Send(msg rawtopicreader.ClientMessage) error
	CloseSend() error
}

type ReadMessageBatchOptions 

type ReadMessageBatchOptions struct {
	// contains filtered or unexported fields
}

type Reader 

type Reader struct {
	// contains filtered or unexported fields
}

func NewReader 

func NewReader(
	connector TopicSteamReaderConnect,
	consumer string,
	readSelectors []PublicReadSelector,
	opts ...PublicReaderOption,
) Reader

func (*Reader) Close 

func (r *Reader) Close(ctx context.Context) error

func (*Reader) Commit 

func (r *Reader) Commit(ctx context.Context, offsets PublicCommitRangeGetter) (err error)

func (*Reader) CommitRanges 

func (r *Reader) CommitRanges(ctx context.Context, ranges []PublicCommitRange) error

func (*Reader) ReadMessage 

func (r *Reader) ReadMessage(ctx context.Context) (*PublicMessage, error)

ReadMessage read exactly one message

func (*Reader) ReadMessageBatch 

func (r *Reader) ReadMessageBatch(ctx context.Context, opts ...PublicReadBatchOption) (batch *PublicBatch, err error)

ReadMessageBatch read batch of messages. Batch is collection of messages, which can be atomically committed

type ReaderConfig 

type ReaderConfig struct {
	config.Common

	DefaultBatchConfig ReadMessageBatchOptions
	// contains filtered or unexported fields
}

type TopicSteamReaderConnect 

type TopicSteamReaderConnect func(connectionCtx context.Context) (RawTopicReaderStream, error)

TopicSteamReaderConnect connect to grpc stream when connectionCtx closed stream must stop work and return errors for all methods

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.