state

package

v1.17.7-rc.4 Latest Latest Go to latest Published: May 15, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dapr/dapr

Links

Documentation ¶

Index ¶

Constants
type Options
type State
- func LoadWorkflowState(ctx context.Context, state state.Interface, actorID string, opts Options) (*State, error)
- func NewState(opts Options) *State

Constants ¶

View Source

const (

	// MetadataKey is the state-store key holding the workflow's metadata row
	// (history/inbox lengths + generation). Exported so other packages can
	// refresh just this row to pick up the latest ETag without reloading the
	// full workflow state.
	MetadataKey = "metadata"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	AppID             string
	WorkflowActorType string
	ActivityActorType string
}

type State ¶

type State struct {
	Inbox        []*backend.HistoryEvent
	History      []*backend.HistoryEvent
	CustomStatus *wrapperspb.StringValue
	Generation   uint64
	// contains filtered or unexported fields
}

func LoadWorkflowState ¶

func LoadWorkflowState(ctx context.Context, state state.Interface, actorID string, opts Options) (*State, error)

func NewState ¶

func NewState(opts Options) *State

func (*State) AddToHistory ¶ added in v1.16.0

func (s *State) AddToHistory(e *backend.HistoryEvent)

func (*State) AddToInbox ¶

func (s *State) AddToInbox(e *backend.HistoryEvent)

func (*State) ApplyRuntimeStateChanges ¶

func (s *State) ApplyRuntimeStateChanges(rs *backend.OrchestrationRuntimeState)

func (*State) ClearInbox ¶

func (s *State) ClearInbox()

func (*State) FromWorkflowState ¶ added in v1.16.0

func (s *State) FromWorkflowState(state *backend.WorkflowState)

func (*State) GetPurgeRequest ¶

func (s *State) GetPurgeRequest(actorID string) (*api.TransactionalRequest, error)

func (*State) GetSaveRequest ¶

func (s *State) GetSaveRequest(actorID string) (*api.TransactionalRequest, error)

func (*State) MetadataETag ¶ added in v1.17.7

func (s *State) MetadataETag() *string

MetadataETag returns the cached metadata ETag, or nil if none is known. Callers performing optimistic concurrency pass this through to the metadata TransactionalUpsert via [GetSaveRequest].

func (*State) Reset ¶

func (s *State) Reset()

func (*State) ResetChangeTracking ¶

func (s *State) ResetChangeTracking()

ResetChangeTracking resets the change tracking counters. This should be called after a save request.

func (*State) SetMetadataETag ¶ added in v1.17.7

func (s *State) SetMetadataETag(etag *string)

SetMetadataETag updates the cached metadata ETag. Called after a successful save to record the new row-version token returned by a follow-up metadata-only Get, so the next save can present it as the prior ETag for the optimistic-concurrency check.

func (*State) String ¶

func (s *State) String() string

String implements fmt.Stringer and is primarily used for debugging purposes.

func (*State) ToWorkflowState ¶ added in v1.16.0

func (s *State) ToWorkflowState() *backend.WorkflowState

Source Files ¶

View all Source files

state.go

Directories ¶

Path	Synopsis
list

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