mqtt

package

v0.0.0-...-fa2bc5f Latest Latest Go to latest Published: Jul 7, 2021 License: ISC Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/someone235/katnip

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Close()
func Connect() error
func GetClient() (mqtt.Client, error)
func PublishBlockAddedNotifications(hash string) error
func PublishSelectedParentChainNotifications(removedChainHashes []string, addedChainBlocks []*appmessage.ChainBlock) error
func PublishSelectedTipNotification(selectedTipHash string) error
func PublishUnacceptedTransactionsNotifications(unacceptedTransactions []*dbmodels.Transaction) error

Constants ¶

View Source

const (
	// TransactionsTopic is an MQTT topic for transactions
	TransactionsTopic = "transactions"

	// AcceptedTransactionsTopic is an MQTT topic for accepted transactions
	AcceptedTransactionsTopic = "transactions/accepted"

	// UnacceptedTransactionsTopic is an MQTT topic for unaccepted transactions
	UnacceptedTransactionsTopic = "transactions/unaccepted"
)

View Source

const BlocksTopic = "dag/blocks"

BlocksTopic is an MQTT topic for new blocks

View Source

const SelectedParentChainTopic = "dag/selected-parent-chain"

SelectedParentChainTopic is an MQTT topic for changes in the selected parent chain

View Source

const (
	// SelectedTipTopic is an MQTT topic for DAG selected tips
	SelectedTipTopic = "dag/selected-tip"
)

Variables ¶

This section is empty.

Functions ¶

func Close ¶

func Close()

Close closes the connection to the MQTT server, if previously connected

func Connect ¶

func Connect() error

Connect initiates a connection to the MQTT server, if defined

func GetClient ¶

func GetClient() (mqtt.Client, error)

GetClient returns an instance of the MQTT client, in case we have an active connection

func PublishBlockAddedNotifications ¶

func PublishBlockAddedNotifications(hash string) error

PublishBlockAddedNotifications publishes notifications for the block that was added, and notifications for its transactions.

func PublishSelectedParentChainNotifications ¶

func PublishSelectedParentChainNotifications(removedChainHashes []string, addedChainBlocks []*appmessage.ChainBlock) error

PublishSelectedParentChainNotifications publishes notifications for changes in the selected parent chain

func PublishSelectedTipNotification ¶

func PublishSelectedTipNotification(selectedTipHash string) error

PublishSelectedTipNotification publishes notification for a new selected tip

func PublishUnacceptedTransactionsNotifications ¶

func PublishUnacceptedTransactionsNotifications(unacceptedTransactions []*dbmodels.Transaction) error

PublishUnacceptedTransactionsNotifications publishes notification for each unaccepted transaction of the given chain-block

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL