sessionreducer

package
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Nov 8, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DROP = fmt.Sprintf("%U__DROP__", '\\') // U+005C__DROP__
)

Functions

func NewServer

func NewServer(r SessionReducerCreator, inputOptions ...Option) numaflow.Server

NewServer creates a new session reduce server.

Types

type Datum

type Datum interface {
	// Value returns the payload of the message.
	Value() []byte
	// EventTime returns the event time of the message.
	EventTime() time.Time
	// Watermark returns the watermark of the message.
	Watermark() time.Time
	// Headers returns the headers of the message.
	Headers() map[string]string
}

Datum contains methods to get the payload information.

func NewHandlerDatum

func NewHandlerDatum(value []byte, eventTime time.Time, watermark time.Time, headers map[string]string) Datum

type Message

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

Message is used to wrap the data return by SessionReduce functions

func MessageToDrop

func MessageToDrop() Message

MessageToDrop creates a Message to be dropped

func NewMessage

func NewMessage(value []byte) Message

NewMessage creates a Message with value

func (Message) Keys

func (m Message) Keys() []string

Keys returns message keys

func (Message) Tags

func (m Message) Tags() []string

Tags returns message tags

func (Message) Value

func (m Message) Value() []byte

Value returns message value

func (Message) WithKeys

func (m Message) WithKeys(keys []string) Message

WithKeys is used to assign the keys to the message

func (Message) WithTags

func (m Message) WithTags(tags []string) Message

WithTags is used to assign the tags to the message tags will be used for conditional forwarding

type Option

type Option func(*options)

Option is the interface to apply options.

func WithMaxMessageSize

func WithMaxMessageSize(size int) Option

WithMaxMessageSize sets the server max receive message size and the server max send message size to the given size.

func WithServerInfoFilePath

func WithServerInfoFilePath(f string) Option

WithServerInfoFilePath sets the server info file path to the given path.

func WithSockAddr

func WithSockAddr(addr string) Option

WithSockAddr start the server with the given sock addr. This is mainly used for testing purposes.

type Service

type Service struct {
	sessionreducepb.UnimplementedSessionReduceServer
	// contains filtered or unexported fields
}

Service implements the proto gen server interface and contains the sesionreduce operation handler.

func (*Service) IsReady

IsReady returns true to indicate the gRPC connection is ready.

func (*Service) SessionReduceFn

SessionReduceFn applies a session reduce function to a request stream and streams the results.

type SessionReducer

type SessionReducer interface {
	// SessionReduce applies a session reduce function to a request stream and streams the results.
	SessionReduce(ctx context.Context, keys []string, inputCh <-chan Datum, outputCh chan<- Message)
	// Accumulator returns the accumulator for the session reducer, will be invoked when this session is merged
	// with another session.
	Accumulator(ctx context.Context) []byte
	// MergeAccumulator merges the accumulator for the session reducer, will be invoked when another session is merged
	// with this session.
	MergeAccumulator(ctx context.Context, accumulator []byte)
}

SessionReducer is the interface which can be used to implement a session reduce operation.

type SessionReducerCreator

type SessionReducerCreator interface {
	// Create creates a session reducer, will be invoked once for every keyed window.
	Create() SessionReducer
}

SessionReducerCreator is the interface which can be used to create a session reducer.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL