serverinfo

Documentation

Index

• Constants
• Variables
• type ContainerType
• type Language
• type MapMode
• type Option
  • func WithServerInfoFilePath(f string) Option
  • func WithServerInfoReadinessTimeout(t time.Duration) Option
• type Options
  • func DefaultOptions() *Options
  • func (o *Options) ServerInfoFilePath() string
  • func (o *Options) ServerInfoReadinessTimeout() time.Duration
• type Protocol
• type ServerInfo
  • func SDKServerInfo(inputOptions ...Option) (*ServerInfo, error)

Constants

const (
	// MultiProcKey is the field used to indicate that MultiProc map mode is enabled
	// The value contains the number of servers spawned.
	MultiProcKey = "MULTIPROC"
	// MapModeKey field is used to indicate which map mode is enabled
	// If none is set, we consider the unary map as default
	MapModeKey = "MAP_MODE"
)

Metadata keys used in the server info file

Variables

var END = fmt.Sprintf("%U__END__", '\\')

Types

type ContainerType

type ContainerType string

type Language

type Language string

const (
	Go     Language = "go"
	Python Language = "python"
	Java   Language = "java"
	Rust   Language = "rust"
)

type MapMode

type MapMode string

const (
	UnaryMap  MapMode = "unary-map"
	StreamMap MapMode = "stream-map"
	BatchMap  MapMode = "batch-map"
)

type Option

type Option func(*Options)

Option is the interface to apply Options.

func WithServerInfoFilePath

func WithServerInfoFilePath(f string) Option

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

func WithServerInfoReadinessTimeout

func WithServerInfoReadinessTimeout(t time.Duration) Option

WithServerInfoReadinessTimeout sets the server info readiness timeout to the given timeout.

type Options

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

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns the default options.

func (*Options) ServerInfoFilePath

func (o *Options) ServerInfoFilePath() string

ServerInfoFilePath returns the server info file path.

func (*Options) ServerInfoReadinessTimeout

func (o *Options) ServerInfoReadinessTimeout() time.Duration

ServerInfoReadinessTimeout returns the server info readiness timeout.

type Protocol

type Protocol string

const (
	UDS Protocol = "uds"
	TCP Protocol = "tcp"
)

type ServerInfo

type ServerInfo struct {
	Protocol               Protocol          `json:"protocol"`
	Language               Language          `json:"language"`
	MinimumNumaflowVersion string            `json:"minimum_numaflow_version"`
	Version                string            `json:"version"`
	Metadata               map[string]string `json:"metadata"`
}

ServerInfo is the information about the server

func SDKServerInfo

func SDKServerInfo(inputOptions ...Option) (*ServerInfo, error)

SDKServerInfo wait for the server to start and return the server info.