grpc

Documentation

Index

• type API
  • func NewAPI(opts APIOpts) API
• type APIOpts
• type Options
• type OptionsInternal
• type Server
  • func NewAPIServer(opts Options) Server
  • func NewInternalServer(opts OptionsInternal) Server
• type ServerConfig

Types

type API

type API interface {
	io.Closer

	// DaprInternal Service methods
	internalv1pb.ServiceInvocationServer

	// Dapr Service methods
	runtimev1pb.DaprServer

	// Methods internal to the object
	SetActorRuntime(actor actors.ActorRuntime)
}

API is the gRPC interface for the Dapr gRPC API. It implements both the internal and external proto definitions.

func NewAPI

func NewAPI(opts APIOpts) API

NewAPI returns a new gRPC API.

type APIOpts

type APIOpts struct {
	Universal             *universal.Universal
	Logger                logger.Logger
	Channels              *channels.Channels
	PubSubAdapter         runtimePubsub.Adapter
	PubSubAdapterStreamer runtimePubsub.AdapterStreamer
	Outbox                outbox.Outbox
	DirectMessaging       invokev1.DirectMessaging
	SendToOutputBindingFn func(ctx context.Context, name string, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error)
	TracingSpec           config.TracingSpec
	AccessControlList     *config.AccessControlList
	Processor             *processor.Processor
}

APIOpts contains options for NewAPI.

type Options

type Options struct {
	API            API
	Config         ServerConfig
	TracingSpec    config.TracingSpec
	MetricSpec     config.MetricSpec
	APISpec        config.APISpec
	Proxy          messaging.Proxy
	WorkflowEngine *wfengine.WorkflowEngine
	Healthz        healthz.Healthz
}

type OptionsInternal

type OptionsInternal struct {
	API         API
	Config      ServerConfig
	TracingSpec config.TracingSpec
	MetricSpec  config.MetricSpec
	Security    security.Handler
	Proxy       messaging.Proxy
	Healthz     healthz.Healthz
}

type Server

type Server interface {
	io.Closer
	StartNonBlocking() error
}

Server is an interface for the dapr gRPC server.

func NewAPIServer

func NewAPIServer(opts Options) Server

NewAPIServer returns a new user facing gRPC API server.

func NewInternalServer

func NewInternalServer(opts OptionsInternal) Server

NewInternalServer returns a new gRPC server for Dapr to Dapr communications.

type ServerConfig

type ServerConfig struct {
	AppID              string
	HostAddress        string
	Port               int
	APIListenAddresses []string
	NameSpace          string
	TrustDomain        string
	MaxRequestBodySize int // In bytes
	ReadBufferSize     int // In bytes
	UnixDomainSocket   string
	EnableAPILogging   bool
}

ServerConfig is the config object for a grpc server.