mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-03-30 15:08:33 +00:00
1a569c7bd7
* [NOD-270] Added notifyChainChanges and related commands. * [NOD-270] Added NTChainChanged to blockdag. * [NOD-270] Implemented collection and sending of ChainChanged notifications. * [NOD-270] Fixed an improperly named test. * [NOD-270] Added a test: TestChainChangedNotification. * [NOD-270] Fixed a couple copy+paste errors. * [NOD-270] Added a couple of comments for TestChainChangedNotification. * [NOD-270] Fixed formatting error. * [NOD-270] Fixed a comment. * [NOD-270] Uncoupled chain updates inside blockdag from the concept of a notification. * [NOD-270] Removed intermediary ChainUpdates object from ChainChangedNotificationData.
90 lines
2.8 KiB
Go
90 lines
2.8 KiB
Go
// Copyright (c) 2013-2016 The btcsuite developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package blockdag
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/daglabs/btcd/util"
|
|
"github.com/daglabs/btcd/util/daghash"
|
|
)
|
|
|
|
// NotificationType represents the type of a notification message.
|
|
type NotificationType int
|
|
|
|
// NotificationCallback is used for a caller to provide a callback for
|
|
// notifications about various chain events.
|
|
type NotificationCallback func(*Notification)
|
|
|
|
// Constants for the type of a notification message.
|
|
const (
|
|
// NTBlockAdded indicates the associated block was added into
|
|
// the blockDAG.
|
|
NTBlockAdded NotificationType = iota
|
|
|
|
// NTChainChanged indicates that selected parent
|
|
// chain had changed.
|
|
NTChainChanged
|
|
)
|
|
|
|
// notificationTypeStrings is a map of notification types back to their constant
|
|
// names for pretty printing.
|
|
var notificationTypeStrings = map[NotificationType]string{
|
|
NTBlockAdded: "NTBlockAdded",
|
|
NTChainChanged: "NTChainChanged",
|
|
}
|
|
|
|
// String returns the NotificationType in human-readable form.
|
|
func (n NotificationType) String() string {
|
|
if s, ok := notificationTypeStrings[n]; ok {
|
|
return s
|
|
}
|
|
return fmt.Sprintf("Unknown Notification Type (%d)", int(n))
|
|
}
|
|
|
|
// Notification defines notification that is sent to the caller via the callback
|
|
// function provided during the call to New and consists of a notification type
|
|
// as well as associated data that depends on the type as follows:
|
|
// - Added: *util.Block
|
|
type Notification struct {
|
|
Type NotificationType
|
|
Data interface{}
|
|
}
|
|
|
|
// Subscribe to block chain notifications. Registers a callback to be executed
|
|
// when various events take place. See the documentation on Notification and
|
|
// NotificationType for details on the types and contents of notifications.
|
|
func (dag *BlockDAG) Subscribe(callback NotificationCallback) {
|
|
dag.notificationsLock.Lock()
|
|
dag.notifications = append(dag.notifications, callback)
|
|
dag.notificationsLock.Unlock()
|
|
}
|
|
|
|
// sendNotification sends a notification with the passed type and data if the
|
|
// caller requested notifications by providing a callback function in the call
|
|
// to New.
|
|
func (dag *BlockDAG) sendNotification(typ NotificationType, data interface{}) {
|
|
// Generate and send the notification.
|
|
n := Notification{Type: typ, Data: data}
|
|
dag.notificationsLock.RLock()
|
|
for _, callback := range dag.notifications {
|
|
callback(&n)
|
|
}
|
|
dag.notificationsLock.RUnlock()
|
|
}
|
|
|
|
// BlockAddedNotificationData defines data to be sent along with a BlockAdded
|
|
// notification
|
|
type BlockAddedNotificationData struct {
|
|
Block *util.Block
|
|
WasUnorphaned bool
|
|
}
|
|
|
|
// ChainChangedNotificationData defines data to be sent along with a ChainChanged
|
|
// notification
|
|
type ChainChangedNotificationData struct {
|
|
RemovedChainBlockHashes []*daghash.Hash
|
|
AddedChainBlockHashes []*daghash.Hash
|
|
}
|