runtime

Documentation

Index

• Constants
• Variables
• type ComponentCategory
• type ComponentRegistry
• type ComponentsCallback
• type Config
  • func NewRuntimeConfig(id string, placementAddresses []string, ...) *Config
• type DaprRuntime
  • func FromFlags() (*DaprRuntime, error)
  • func NewDaprRuntime(runtimeConfig *Config, globalConfig *config.Configuration, ...) *DaprRuntime
  • func (a *DaprRuntime) GetPubSub(pubsubName string) pubsub.PubSub
  • func (a *DaprRuntime) Publish(req *pubsub.PublishRequest) error
  • func (a *DaprRuntime) Run(opts ...Option) error
  • func (a *DaprRuntime) Shutdown(duration time.Duration)
  • func (a *DaprRuntime) ShutdownWithWait()
  • func (a *DaprRuntime) WaitUntilShutdown() error
• type Option
  • func WithComponentsCallback(componentsCallback ComponentsCallback) Option
  • func WithConfigurations(configurations ...configuration.Configuration) Option
  • func WithHTTPMiddleware(httpMiddleware ...http.Middleware) Option
  • func WithInputBindings(inputBindings ...bindings.InputBinding) Option
  • func WithLocks(locks ...lock.Lock) Option
  • func WithNameResolutions(nameResolutions ...nameresolution.NameResolution) Option
  • func WithOutputBindings(outputBindings ...bindings.OutputBinding) Option
  • func WithPubSubs(pubsubs ...pubsub.PubSub) Option
  • func WithSecretStores(secretStores ...secretstores.SecretStore) Option
  • func WithStates(states ...state.State) Option
• type Protocol
• type Route
• type TopicRoute

Constants

const (
	// GRPCProtocol is a gRPC communication protocol.
	GRPCProtocol Protocol = "grpc"
	// HTTPProtocol is a HTTP communication protocol.
	HTTPProtocol Protocol = "http"
	// DefaultDaprHTTPPort is the default http port for Dapr.
	DefaultDaprHTTPPort = 3500
	// DefaultDaprPublicPort is the default http port for Dapr.
	DefaultDaprPublicPort = 3501
	// DefaultDaprAPIGRPCPort is the default API gRPC port for Dapr.
	DefaultDaprAPIGRPCPort = 50001
	// DefaultProfilePort is the default port for profiling endpoints.
	DefaultProfilePort = 7777
	// DefaultMetricsPort is the default port for metrics endpoints.
	DefaultMetricsPort = 9090
	// DefaultMaxRequestBodySize is the default option for the maximum body size in MB for Dapr HTTP servers.
	DefaultMaxRequestBodySize = 4
	// DefaultAPIListenAddress is which address to listen for the Dapr HTTP and GRPC APIs. Empty string is all addresses.
	DefaultAPIListenAddress = ""
	// DefaultReadBufferSize is the default option for the maximum header size in KB for Dapr HTTP servers.
	DefaultReadBufferSize = 4
)

Variables

var ErrUnexpectedEnvelopeData = errors.New("unexpected data type encountered in envelope")

ErrUnexpectedEnvelopeData denotes that an unexpected data type was encountered when processing a cloud event's data property.

Types

type ComponentCategory

type ComponentCategory string

type ComponentRegistry

type ComponentRegistry struct {
	Actors          actors.Actors
	DirectMessaging messaging.DirectMessaging
	StateStores     map[string]state.Store
	InputBindings   map[string]bindings.InputBinding
	OutputBindings  map[string]bindings.OutputBinding
	SecretStores    map[string]secretstores.SecretStore
	PubSubs         map[string]pubsub.PubSub
}

type ComponentsCallback

type ComponentsCallback func(components ComponentRegistry) error

type Config

type Config struct {
	ID                  string
	HTTPPort            int
	PublicPort          *int
	ProfilePort         int
	EnableProfiling     bool
	APIGRPCPort         int
	InternalGRPCPort    int
	ApplicationPort     int
	APIListenAddresses  []string
	ApplicationProtocol Protocol
	Mode                modes.DaprMode
	PlacementAddresses  []string
	GlobalConfig        string
	AllowedOrigins      string
	Standalone          config.StandaloneConfig
	Kubernetes          config.KubernetesConfig
	MaxConcurrency      int

	SentryServiceAddress         string
	CertChain                    *credentials.CertChain
	AppSSL                       bool
	MaxRequestBodySize           int
	UnixDomainSocket             string
	ReadBufferSize               int
	StreamRequestBody            bool
	GracefulShutdownDuration     time.Duration
	EnableAPILogging             bool
	DisableBuiltinK8sSecretStore bool
	// contains filtered or unexported fields
}

Config holds the Dapr Runtime configuration.

func NewRuntimeConfig

func NewRuntimeConfig(
	id string, placementAddresses []string, controlPlaneAddress, allowedOrigins, globalConfig, componentsPath,
	appProtocol, mode string, httpPort, internalGRPCPort, apiGRPCPort int, apiListenAddresses []string, publicPort *int,
	appPort, profilePort int, enableProfiling bool, maxConcurrency int, mtlsEnabled bool, sentryAddress string, appSSL bool,
	maxRequestBodySize int, unixDomainSocket string, readBufferSize int, streamRequestBody bool, gracefulShutdownDuration time.Duration, enableAPILogging bool, disableBuiltinK8sSecretStore bool,
) *Config

NewRuntimeConfig returns a new runtime config.

type DaprRuntime

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

DaprRuntime holds all the core components of the runtime.

func FromFlags

func FromFlags() (*DaprRuntime, error)

FromFlags parses command flags and returns DaprRuntime instance.

func NewDaprRuntime

func NewDaprRuntime(runtimeConfig *Config, globalConfig *config.Configuration, accessControlList *config.AccessControlList, resiliencyProvider resiliency.Provider) *DaprRuntime

NewDaprRuntime returns a new runtime with the given runtime config and global config.

func (*DaprRuntime) GetPubSub

func (a *DaprRuntime) GetPubSub(pubsubName string) pubsub.PubSub

GetPubSub is an adapter method to find a pubsub by name.

func (*DaprRuntime) Publish

func (a *DaprRuntime) Publish(req *pubsub.PublishRequest) error

Publish is an adapter method for the runtime to pre-validate publish requests And then forward them to the Pub/Sub component. This method is used by the HTTP and gRPC APIs.

func (*DaprRuntime) Run

func (a *DaprRuntime) Run(opts ...Option) error

Run performs initialization of the runtime with the runtime and global configurations.

func (*DaprRuntime) Shutdown

func (a *DaprRuntime) Shutdown(duration time.Duration)

func (*DaprRuntime) ShutdownWithWait

func (a *DaprRuntime) ShutdownWithWait()

ShutdownWithWait will gracefully stop runtime and wait outstanding operations.

func (*DaprRuntime) WaitUntilShutdown

func (a *DaprRuntime) WaitUntilShutdown() error

type Option

type Option func(o *runtimeOpts)

Option is a function that customizes the runtime.

func WithComponentsCallback

func WithComponentsCallback(componentsCallback ComponentsCallback) Option

WithComponentsCallback sets the components callback for applications that embed Dapr.

func WithConfigurations

func WithConfigurations(configurations ...configuration.Configuration) Option

WithConfigurations adds configuration store components to the runtime.

func WithHTTPMiddleware

func WithHTTPMiddleware(httpMiddleware ...http.Middleware) Option

WithHTTPMiddleware adds HTTP middleware components to the runtime.

func WithInputBindings

func WithInputBindings(inputBindings ...bindings.InputBinding) Option

WithInputBindings adds input binding components to the runtime.

func WithLocks

func WithLocks(locks ...lock.Lock) Option

func WithNameResolutions

func WithNameResolutions(nameResolutions ...nameresolution.NameResolution) Option

WithNameResolutions adds name resolution components to the runtime.

func WithOutputBindings

func WithOutputBindings(outputBindings ...bindings.OutputBinding) Option

WithOutputBindings adds output binding components to the runtime.

func WithPubSubs

func WithPubSubs(pubsubs ...pubsub.PubSub) Option

WithPubSubs adds pubsub store components to the runtime.

func WithSecretStores

func WithSecretStores(secretStores ...secretstores.SecretStore) Option

WithSecretStores adds secret store components to the runtime.

func WithStates

func WithStates(states ...state.State) Option

WithStates adds state store components to the runtime.

type Protocol

type Protocol string

Protocol is a communications protocol.

type Route

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

type TopicRoute

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