summaryrefslogtreecommitdiff
path: root/node/error.go
blob: ea4ad835751b559064bca34af531642e432e58c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package node

import (
	"fmt"
)

// Catchpoint already in progress error

// CatchpointAlreadyInProgressError indicates that the requested catchpoint is already running
type CatchpointAlreadyInProgressError struct {
	catchpoint string
}

// MakeCatchpointAlreadyInProgressError creates the error
func MakeCatchpointAlreadyInProgressError(catchpoint string) *CatchpointAlreadyInProgressError {
	return &CatchpointAlreadyInProgressError{
		catchpoint: catchpoint,
	}
}

// Error satisfies builtin interface `error`
func (e *CatchpointAlreadyInProgressError) Error() string {
	return fmt.Sprintf("the requested catchpoint '%s' is already in progress, suppressing error", e.catchpoint)
}

// Catchpoint unable to start error

// CatchpointUnableToStartError indicates that the requested catchpoint cannot be started
type CatchpointUnableToStartError struct {
	catchpointRunning   string
	catchpointRequested string
}

// MakeCatchpointUnableToStartError creates the error
func MakeCatchpointUnableToStartError(catchpointRunning, catchpointRequested string) *CatchpointUnableToStartError {
	return &CatchpointUnableToStartError{
		catchpointRunning:   catchpointRunning,
		catchpointRequested: catchpointRequested,
	}
}

// Error satisfies builtin interface `error`
func (e *CatchpointUnableToStartError) Error() string {
	return fmt.Sprintf(
		"unable to start catchpoint catchup for '%s' - already catching up '%s'",
		e.catchpointRequested,
		e.catchpointRunning)
}

// StartCatchpointError is returned when the catchpoint service cannot start up.
type StartCatchpointError struct {
	catchpointRequested string
	err                 error
}

// MakeStartCatchpointError creates a StartCatchpointError for a given catchpoint
func MakeStartCatchpointError(catchpointRequested string, err error) *StartCatchpointError {
	return &StartCatchpointError{
		catchpointRequested: catchpointRequested,
		err:                 err,
	}
}

// Error satisfies the builtin interface `error`
func (e *StartCatchpointError) Error() string {
	return fmt.Sprintf(
		"unable to start catchpoint service for requested catchpoint %s: %s",
		e.catchpointRequested,
		e.err,
	)
}