events

Documentation

Overview

Package events is a generated GoMock package.

Package events is a generated GoMock package.

Index

• type Cache
  • func NewCache(shardID int, historyManager persistence.HistoryManager, config *config.Config, ...) Cache
  • func NewGlobalCache(initialCount int, maxCount int, ttl time.Duration, ...) Cache
• type MockCache
  • func NewMockCache(ctrl *gomock.Controller) *MockCache
  • func (m *MockCache) EXPECT() *MockCacheMockRecorder
  • func (m *MockCache) GetEvent(ctx context.Context, shardID int, domainID, workflowID, runID string, ...) (*types.HistoryEvent, error)
  • func (m *MockCache) PutEvent(domainID, workflowID, runID string, eventID int64, event *types.HistoryEvent)
• type MockCacheMockRecorder
  • func (mr *MockCacheMockRecorder) GetEvent(...) *gomock.Call
  • func (mr *MockCacheMockRecorder) PutEvent(domainID, workflowID, runID, eventID, event interface{}) *gomock.Call
• type MockNotifier
  • func NewMockNotifier(ctrl *gomock.Controller) *MockNotifier
  • func (m *MockNotifier) EXPECT() *MockNotifierMockRecorder
  • func (m *MockNotifier) NotifyNewHistoryEvent(event *Notification)
  • func (m *MockNotifier) Start()
  • func (m *MockNotifier) Stop()
  • func (m *MockNotifier) UnwatchHistoryEvent(identifier definition.WorkflowIdentifier, subscriberID string) error
  • func (m *MockNotifier) WatchHistoryEvent(identifier definition.WorkflowIdentifier) (string, chan *Notification, error)
• type MockNotifierMockRecorder
  • func (mr *MockNotifierMockRecorder) NotifyNewHistoryEvent(event interface{}) *gomock.Call
  • func (mr *MockNotifierMockRecorder) Start() *gomock.Call
  • func (mr *MockNotifierMockRecorder) Stop() *gomock.Call
  • func (mr *MockNotifierMockRecorder) UnwatchHistoryEvent(identifier, subscriberID interface{}) *gomock.Call
  • func (mr *MockNotifierMockRecorder) WatchHistoryEvent(identifier interface{}) *gomock.Call
• type Notification
  • func NewNotification(domainID string, workflowExecution *types.WorkflowExecution, ...) *Notification
• type Notifier
  • func NewNotifier(timeSource clock.TimeSource, metrics metrics.Client, ...) Notifier
• type PersistedBlob
• type PersistedBlobs
  • func (blobs PersistedBlobs) Find(branchToken []byte, firstEventID int64) *persistence.DataBlob

Types

type Cache

type Cache interface {
	GetEvent(
		ctx context.Context,
		shardID int,
		domainID string,
		workflowID string,
		runID string,
		firstEventID int64,
		eventID int64,
		branchToken []byte,
	) (*types.HistoryEvent, error)
	PutEvent(
		domainID string,
		workflowID string,
		runID string,
		eventID int64,
		event *types.HistoryEvent,
	)
}

Cache caches workflow history event

func NewCache

func NewCache(
	shardID int,
	historyManager persistence.HistoryManager,
	config *config.Config,
	logger log.Logger,
	metricsClient metrics.Client,
	domainCache cache.DomainCache,
) Cache

NewCache creates a new events cache

func NewGlobalCache

func NewGlobalCache(
	initialCount int,
	maxCount int,
	ttl time.Duration,
	historyManager persistence.HistoryManager,
	logger log.Logger,
	metricsClient metrics.Client,
	maxSize uint64,
	domainCache cache.DomainCache,
) Cache

NewGlobalCache creates a new global events cache

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) GetEvent

func (m *MockCache) GetEvent(ctx context.Context, shardID int, domainID, workflowID, runID string, firstEventID, eventID int64, branchToken []byte) (*types.HistoryEvent, error)

GetEvent mocks base method.

func (*MockCache) PutEvent

func (m *MockCache) PutEvent(domainID, workflowID, runID string, eventID int64, event *types.HistoryEvent)

PutEvent mocks base method.

type MockCacheMockRecorder

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

MockCacheMockRecorder is the mock recorder for MockCache.

func (*MockCacheMockRecorder) GetEvent

func (mr *MockCacheMockRecorder) GetEvent(ctx, shardID, domainID, workflowID, runID, firstEventID, eventID, branchToken interface{}) *gomock.Call

GetEvent indicates an expected call of GetEvent.

func (*MockCacheMockRecorder) PutEvent

func (mr *MockCacheMockRecorder) PutEvent(domainID, workflowID, runID, eventID, event interface{}) *gomock.Call

PutEvent indicates an expected call of PutEvent.

type MockNotifier

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

MockNotifier is a mock of Notifier interface.

func NewMockNotifier

func NewMockNotifier(ctrl *gomock.Controller) *MockNotifier

NewMockNotifier creates a new mock instance.

func (*MockNotifier) EXPECT

func (m *MockNotifier) EXPECT() *MockNotifierMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockNotifier) NotifyNewHistoryEvent

func (m *MockNotifier) NotifyNewHistoryEvent(event *Notification)

NotifyNewHistoryEvent mocks base method.

func (*MockNotifier) Start

func (m *MockNotifier) Start()

Start mocks base method.

func (*MockNotifier) Stop

func (m *MockNotifier) Stop()

Stop mocks base method.

func (*MockNotifier) UnwatchHistoryEvent

func (m *MockNotifier) UnwatchHistoryEvent(identifier definition.WorkflowIdentifier, subscriberID string) error

UnwatchHistoryEvent mocks base method.

func (*MockNotifier) WatchHistoryEvent

func (m *MockNotifier) WatchHistoryEvent(identifier definition.WorkflowIdentifier) (string, chan *Notification, error)

WatchHistoryEvent mocks base method.

type MockNotifierMockRecorder

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

MockNotifierMockRecorder is the mock recorder for MockNotifier.

func (*MockNotifierMockRecorder) NotifyNewHistoryEvent

func (mr *MockNotifierMockRecorder) NotifyNewHistoryEvent(event interface{}) *gomock.Call

NotifyNewHistoryEvent indicates an expected call of NotifyNewHistoryEvent.

func (*MockNotifierMockRecorder) Start

func (mr *MockNotifierMockRecorder) Start() *gomock.Call

Start indicates an expected call of Start.

func (*MockNotifierMockRecorder) Stop

func (mr *MockNotifierMockRecorder) Stop() *gomock.Call

Stop indicates an expected call of Stop.

func (*MockNotifierMockRecorder) UnwatchHistoryEvent

func (mr *MockNotifierMockRecorder) UnwatchHistoryEvent(identifier, subscriberID interface{}) *gomock.Call

UnwatchHistoryEvent indicates an expected call of UnwatchHistoryEvent.

func (*MockNotifierMockRecorder) WatchHistoryEvent

func (mr *MockNotifierMockRecorder) WatchHistoryEvent(identifier interface{}) *gomock.Call

WatchHistoryEvent indicates an expected call of WatchHistoryEvent.

type Notification

type Notification struct {
	ID                     definition.WorkflowIdentifier
	LastFirstEventID       int64
	NextEventID            int64
	PreviousStartedEventID int64
	Timestamp              time.Time
	CurrentBranchToken     []byte
	WorkflowState          int
	WorkflowCloseState     int
}

Notification is the notification for new history events

func NewNotification

func NewNotification(
	domainID string,
	workflowExecution *types.WorkflowExecution,
	lastFirstEventID int64,
	nextEventID int64,
	previousStartedEventID int64,
	currentBranchToken []byte,
	workflowState int,
	workflowCloseState int,
) *Notification

NewNotification creates a new history event notification

type Notifier

type Notifier interface {
	common.Daemon
	NotifyNewHistoryEvent(event *Notification)
	WatchHistoryEvent(identifier definition.WorkflowIdentifier) (string, chan *Notification, error)
	UnwatchHistoryEvent(identifier definition.WorkflowIdentifier, subscriberID string) error
}

Notifier is a pub-sub for sending and receiving notifications on new history events

func NewNotifier

func NewNotifier(
	timeSource clock.TimeSource,
	metrics metrics.Client,
	workflowIDToShardID func(string) int,
) Notifier

NewNotifier creates a new history event notifier

type PersistedBlob

type PersistedBlob struct {
	persistence.DataBlob

	BranchToken  []byte
	FirstEventID int64
}

PersistedBlob is a wrapper on persistence.DataBlob with additional field indicating what was persisted. Additional fields are used as an identification key among other blobs.

type PersistedBlobs

type PersistedBlobs []PersistedBlob

PersistedBlobs is a slice of PersistedBlob

func (PersistedBlobs) Find

func (blobs PersistedBlobs) Find(branchToken []byte, firstEventID int64) *persistence.DataBlob

Find searches for persisted event blob. Returns nil when not found.