Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DispatchHandler ¶
type DispatchHandler func(context.Context, *DispatchPayload) error
type DispatchPayload ¶ added in v1.3.0
type DispatchPayload struct {
Batch core.BatchPersisted
Messages []*core.Message
Data core.DataArray
Pins []*fftypes.Bytes32
MessageUpdates map[string]*MessageUpdate
}
type DispatcherOptions ¶ added in v0.13.0
type FlushStatus ¶ added in v0.13.0
type FlushStatus struct {
LastFlushTime *fftypes.FFTime `ffstruct:"BatchFlushStatus" json:"lastFlushStartTime"`
Flushing *fftypes.UUID `ffstruct:"BatchFlushStatus" json:"flushing,omitempty"`
Cancelled bool `ffstruct:"BatchFlushStatus" json:"cancelled"`
Blocked bool `ffstruct:"BatchFlushStatus" json:"blocked"`
LastFlushError string `ffstruct:"BatchFlushStatus" json:"lastFlushError,omitempty"`
LastFlushErrorTime *fftypes.FFTime `ffstruct:"BatchFlushStatus" json:"lastFlushErrorTime,omitempty"`
AverageBatchBytes int64 `ffstruct:"BatchFlushStatus" json:"averageBatchBytes"`
AverageBatchMessages float64 `ffstruct:"BatchFlushStatus" json:"averageBatchMessages"`
AverageBatchData float64 `ffstruct:"BatchFlushStatus" json:"averageBatchData"`
AverageFlushTimeMS int64 `ffstruct:"BatchFlushStatus" json:"averageFlushTimeMS"`
TotalBatches int64 `ffstruct:"BatchFlushStatus" json:"totalBatches"`
TotalErrors int64 `ffstruct:"BatchFlushStatus" json:"totalErrors"`
// contains filtered or unexported fields
}
FlushStatus is an object that can be returned on REST queries to understand the status of the batch processor
type Manager ¶
type Manager interface {
RegisterDispatcher(name string, pinned bool, msgTypes []core.MessageType, handler DispatchHandler, batchOptions DispatcherOptions)
LoadContexts(ctx context.Context, payload *DispatchPayload) error
CancelBatch(ctx context.Context, batchID string) error
NewMessages() chan<- int64
Start() error
Close()
WaitStop()
Status() *ManagerStatus
}
type ManagerStatus ¶ added in v0.13.0
type ManagerStatus struct {
Processors []*ProcessorStatus `ffstruct:"BatchManagerStatus" json:"processors"`
}
type MessageUpdate ¶ added in v1.3.0
type MessageUpdate struct {
// contains filtered or unexported fields
}
type ProcessorStatus ¶ added in v0.13.0
type ProcessorStatus struct {
Dispatcher string `ffstruct:"BatchProcessorStatus" json:"dispatcher"`
Name string `ffstruct:"BatchProcessorStatus" json:"name"`
Status FlushStatus `ffstruct:"BatchProcessorStatus" json:"status"`
}
Click to show internal directories.
Click to hide internal directories.