Documentation
¶
Overview ¶
Package cache is a generated GoMock package.
Index ¶
- Variables
- type Cache
- type CacheImpl
- func (c *CacheImpl) GetOrCreateCurrentWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, ...) (workflow.Context, ReleaseCacheFunc, error)
- func (c *CacheImpl) GetOrCreateWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, ...) (workflow.Context, ReleaseCacheFunc, error)
- type Key
- type MockCache
- func (m *MockCache) EXPECT() *MockCacheMockRecorder
- func (m *MockCache) GetOrCreateCurrentWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, ...) (workflow.Context, ReleaseCacheFunc, error)
- func (m *MockCache) GetOrCreateWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, ...) (workflow.Context, ReleaseCacheFunc, error)
- type MockCacheMockRecorder
- type NewCacheFn
- type ReleaseCacheFunc
Constants ¶
This section is empty.
Variables ¶
var Module = fx.Options( fx.Provide(func(config *configs.Config) Cache { return NewHostLevelCache(config) }), fx.Provide(NewCacheFnProvider), )
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache interface {
GetOrCreateCurrentWorkflowExecution(
ctx context.Context,
shardContext shard.Context,
namespaceID namespace.ID,
workflowID string,
lockPriority workflow.LockPriority,
) (workflow.Context, ReleaseCacheFunc, error)
GetOrCreateWorkflowExecution(
ctx context.Context,
shardContext shard.Context,
namespaceID namespace.ID,
execution *commonpb.WorkflowExecution,
lockPriority workflow.LockPriority,
) (workflow.Context, ReleaseCacheFunc, error)
}
func NewHostLevelCache ¶ added in v1.23.0
func NewShardLevelCache ¶ added in v1.23.0
type CacheImpl ¶
func (*CacheImpl) GetOrCreateCurrentWorkflowExecution ¶ added in v1.20.1
func (*CacheImpl) GetOrCreateWorkflowExecution ¶
func (c *CacheImpl) GetOrCreateWorkflowExecution( ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, execution *commonpb.WorkflowExecution, lockPriority workflow.LockPriority, ) (workflow.Context, ReleaseCacheFunc, error)
type Key ¶ added in v1.23.0
type Key struct {
// Those are exported because some unit tests uses the cache directly.
// TODO: Update the unit tests and make those fields private.
WorkflowKey definition.WorkflowKey
ShardUUID string
}
type MockCache ¶
type MockCache struct {
// contains filtered or unexported fields
}
MockCache is a mock of Cache interface.
func NewMockCache ¶
func NewMockCache(ctrl *gomock.Controller) *MockCache
NewMockCache creates a new mock instance.
func (*MockCache) EXPECT ¶
func (m *MockCache) EXPECT() *MockCacheMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockCache) GetOrCreateCurrentWorkflowExecution ¶ added in v1.20.1
func (m *MockCache) GetOrCreateCurrentWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, workflowID string, lockPriority workflow.LockPriority) (workflow.Context, ReleaseCacheFunc, error)
GetOrCreateCurrentWorkflowExecution mocks base method.
func (*MockCache) GetOrCreateWorkflowExecution ¶
func (m *MockCache) GetOrCreateWorkflowExecution(ctx context.Context, shardContext shard.Context, namespaceID namespace.ID, execution *v1.WorkflowExecution, lockPriority workflow.LockPriority) (workflow.Context, ReleaseCacheFunc, error)
GetOrCreateWorkflowExecution mocks base method.
type MockCacheMockRecorder ¶
type MockCacheMockRecorder struct {
// contains filtered or unexported fields
}
MockCacheMockRecorder is the mock recorder for MockCache.
func (*MockCacheMockRecorder) GetOrCreateCurrentWorkflowExecution ¶ added in v1.20.1
func (mr *MockCacheMockRecorder) GetOrCreateCurrentWorkflowExecution(ctx, shardContext, namespaceID, workflowID, lockPriority interface{}) *gomock.Call
GetOrCreateCurrentWorkflowExecution indicates an expected call of GetOrCreateCurrentWorkflowExecution.
func (*MockCacheMockRecorder) GetOrCreateWorkflowExecution ¶
func (mr *MockCacheMockRecorder) GetOrCreateWorkflowExecution(ctx, shardContext, namespaceID, execution, lockPriority interface{}) *gomock.Call
GetOrCreateWorkflowExecution indicates an expected call of GetOrCreateWorkflowExecution.
type NewCacheFn ¶
func NewCacheFnProvider ¶
func NewCacheFnProvider() NewCacheFn
NewCacheFnProvider provide a NewCacheFn that can be used to create new workflow cache.
type ReleaseCacheFunc ¶
type ReleaseCacheFunc func(err error)
ReleaseCacheFunc must be called to release the workflow context from the cache. Make sure not to access the mutable state or workflow context after releasing back to the cache. If there is any error when using the mutable state (e.g. mutable state is mutated and dirty), call release with the error so the in-memory copy will be thrown away.
var NoopReleaseFn ReleaseCacheFunc = func(err error) {}
Source Files