Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type StopAtHeightCommand ¶ added in v0.28.0
type StopAtHeightCommand struct {
// contains filtered or unexported fields
}
StopAtHeightCommand will send a signal to engine to stop/crash EN at given height
func NewStopAtHeightCommand ¶ added in v0.28.0
func NewStopAtHeightCommand(sah *stop.StopControl) *StopAtHeightCommand
NewStopAtHeightCommand creates a new StopAtHeightCommand object
func (*StopAtHeightCommand) Handler ¶ added in v0.28.0
func (s *StopAtHeightCommand) Handler(_ context.Context, req *admin.CommandRequest) (interface{}, error)
Handler method sets the stop height parameters. Errors only if setting of stop height parameters fails. Returns "ok" if successful.
func (*StopAtHeightCommand) Validator ¶ added in v0.28.0
func (s *StopAtHeightCommand) Validator(req *admin.CommandRequest) error
Validator checks the inputs for StopAtHeight command. It expects the following fields in the Data field of the req object:
- height in a numeric format
- crash, a boolean
Additionally, height must be a positive integer. If a float value is provided, only the integer part is used. The following sentinel errors are expected during normal operations: * `admin.InvalidAdminReqError` if any required field is missing or in a wrong format
type StopAtHeightReq ¶ added in v0.28.0
type StopAtHeightReq struct {
// contains filtered or unexported fields
}
type TriggerCheckpointCommand ¶
type TriggerCheckpointCommand struct {
// contains filtered or unexported fields
}
TriggerCheckpointCommand will send a signal to compactor to trigger checkpoint once finishing writing the current WAL segment file
func NewTriggerCheckpointCommand ¶
func NewTriggerCheckpointCommand(trigger *atomic.Bool) *TriggerCheckpointCommand
func (*TriggerCheckpointCommand) Handler ¶
func (s *TriggerCheckpointCommand) Handler(_ context.Context, _ *admin.CommandRequest) (interface{}, error)
func (*TriggerCheckpointCommand) Validator ¶
func (s *TriggerCheckpointCommand) Validator(_ *admin.CommandRequest) error
Source Files