source

Documentation

Index

• Constants
• func NewSource() sdk.Source
• type Config
  • func Parse(cfg map[string]string) (Config, error)
• type Iterator
• type Source
  • func (s *Source) Configure(ctx context.Context, cfg map[string]string) error
  • func (s *Source) Open(ctx context.Context, position sdk.Position) error
  • func (s *Source) Parameters() map[string]sdk.Parameter
  • func (s *Source) Read(ctx context.Context) (sdk.Record, error)
  • func (s *Source) Teardown(ctx context.Context) error

Constants

const ConfigKeyBufferSize = "bufferSize"

ConfigKeyBufferSize is a config name for a buffer size.

Functions

func NewSource

func NewSource() sdk.Source

NewSource creates new instance of the Source.

Types

type Config

type Config struct {
	config.Config

	BufferSize int `key:"bufferSize" validate:"omitempty,min=64"`
}

Config holds source specific configurable values.

func Parse

func Parse(cfg map[string]string) (Config, error)

Parse maps the incoming map to the Config and validates it.

type Iterator

type Iterator interface {
	HasNext(ctx context.Context) bool
	Next(ctx context.Context) (sdk.Record, error)
	Stop() error
}

Iterator defines an iterator interface.

type Source

type Source struct {
	sdk.UnimplementedSource
	// contains filtered or unexported fields
}

Source operates source logic.

func (*Source) Configure

func (s *Source) Configure(ctx context.Context, cfg map[string]string) error

Configure parses and initializes the config.

func (*Source) Open

func (s *Source) Open(ctx context.Context, position sdk.Position) error

Open opens a connection to NATS and initializes iterators.

func (*Source) Parameters

func (s *Source) Parameters() map[string]sdk.Parameter

Parameters returns a map of named sdk.Parameters that describe how to configure the Source.

func (*Source) Read

func (s *Source) Read(ctx context.Context) (sdk.Record, error)

Read fetches a record from an iterator. If there's no record will return sdk.ErrBackoffRetry. If the Source's errC is not empty will return the underlying error.

func (*Source) Teardown

func (s *Source) Teardown(ctx context.Context) error

Teardown closes connections, stops iterator.