events

Documentation

Overview

Package events defines events published by go-spacemsh node using nodes pubsub

Index

• func InitializeEventPubsub(ur string)
• func Publish(event Event)
• type AtxCreated
  • func (AtxCreated) GetChannel() ChannelID
• type ChannelID
• type DoneCreatingBlock
  • func (DoneCreatingBlock) GetChannel() ChannelID
• type Event
• type EventPublisher
  • func NewEventPublisher(eventURL string) (*EventPublisher, error)
  • func (p *EventPublisher) Close() error
  • func (p *EventPublisher) PublishEvent(event Event) error
• type NewAtx
  • func (NewAtx) GetChannel() ChannelID
• type NewBlock
  • func (NewBlock) GetChannel() ChannelID
• type NewTx
  • func (NewTx) GetChannel() ChannelID
• type Publisher
• type RewardReceived
  • func (RewardReceived) GetChannel() ChannelID
• type Subscriber
  • func NewSubscriber(url string) (*Subscriber, error)
  • func (sub *Subscriber) Close() error
  • func (sub *Subscriber) StartListening()
  • func (sub *Subscriber) Subscribe(topic ChannelID) (chan []byte, error)
  • func (sub *Subscriber) SubscribeToAll() (chan []byte, error)
• type ValidAtx
  • func (ValidAtx) GetChannel() ChannelID
• type ValidBlock
  • func (ValidBlock) GetChannel() ChannelID
• type ValidTx
  • func (ValidTx) GetChannel() ChannelID

Functions

func InitializeEventPubsub

func InitializeEventPubsub(ur string)

InitializeEventPubsub initializes the global pubsub broadcaster server

func Publish

func Publish(event Event)

Publish publishes an event on the pubsub singleton.

Types

type AtxCreated

type AtxCreated struct {
	Created bool
	ID      string
	Layer   uint64
}

AtxCreated signals this miner has created an activation transaction

func (AtxCreated) GetChannel

func (AtxCreated) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type ChannelID

type ChannelID byte

ChannelID is the ID on which subscribers must register in order to listen to messages on the channel.

const (
	EventNewBlock ChannelID = 1 + iota
	EventBlockValid
	EventNewAtx
	EventAtxValid
	EventNewTx
	EventTxValid
	EventRewardReceived
	EventCreatedBlock
	EventCreatedAtx
)

These consts are used as prefixes for different messages in pubsub

type DoneCreatingBlock

type DoneCreatingBlock struct {
	Eligible bool
	Layer    uint64
	Error    string
}

DoneCreatingBlock signals that this miner has created a block

func (DoneCreatingBlock) GetChannel

func (DoneCreatingBlock) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type Event

type Event interface {
	// GetChannel returns the channel on which this message will be published.
	GetChannel() ChannelID
}

Event defines the interface that each message sent by the EventPublisher needs to implemet for it to correctly be routed by topic.

type EventPublisher

type EventPublisher struct {
	*Publisher
}

EventPublisher is the struct that publishes events to subscribers by topics.

func NewEventPublisher

func NewEventPublisher(eventURL string) (*EventPublisher, error)

NewEventPublisher is a constructor for the event publisher, it received a url string in format of tcp://localhost:56565 to start listening for connections.

func (*EventPublisher) Close

func (p *EventPublisher) Close() error

Close closes the published internal socket

func (*EventPublisher) PublishEvent

func (p *EventPublisher) PublishEvent(event Event) error

PublishEvent publishes the provided event on pubsub infra. It encodes messages using XDR protocol.

type NewAtx

type NewAtx struct {
	ID      string
	LayerID uint64
}

NewAtx signals that a new ATX has been received

func (NewAtx) GetChannel

func (NewAtx) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type NewBlock

type NewBlock struct {
	ID    string
	Layer uint64
	Atx   string
}

NewBlock is sent when a new block is created by this miner

func (NewBlock) GetChannel

func (NewBlock) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type NewTx

type NewTx struct {
	ID          string
	Origin      string
	Destination string
	Amount      uint64
	Fee         uint64
}

NewTx signals that a new transaction has been received and not yet validated

func (NewTx) GetChannel

func (NewTx) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type Publisher

type Publisher struct {
	// contains filtered or unexported fields
}

Publisher is a wrapper for mangos pubsub publisher socket

type RewardReceived

type RewardReceived struct {
	Coinbase string
	Amount   uint64
}

RewardReceived signals reward has been received

func (RewardReceived) GetChannel

func (RewardReceived) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type Subscriber

type Subscriber struct {
	// contains filtered or unexported fields
}

Subscriber defines the struct of the receiving end of the pubsub messages.

func NewSubscriber

func NewSubscriber(url string) (*Subscriber, error)

NewSubscriber received url string as input on which it will register to receive messages passed by server.

func (*Subscriber) Close

func (sub *Subscriber) Close() error

Close closes the socket which in turn will Close the listener func

func (*Subscriber) StartListening

func (sub *Subscriber) StartListening()

StartListening runs in a go routine and listens to all channels this subscriber is registered to. it then passes the messages received to the appropriate reader channel.

func (*Subscriber) Subscribe

func (sub *Subscriber) Subscribe(topic ChannelID) (chan []byte, error)

Subscribe subscribes to the given topic, returns a channel on which data from the topic is received.

func (*Subscriber) SubscribeToAll

func (sub *Subscriber) SubscribeToAll() (chan []byte, error)

SubscribeToAll subscribes to all available topics.

type ValidAtx

type ValidAtx struct {
	ID    string
	Valid bool
}

ValidAtx signals that an activation transaction with id ID has been validated

func (ValidAtx) GetChannel

func (ValidAtx) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type ValidBlock

type ValidBlock struct {
	ID    string
	Valid bool
}

ValidBlock signals that block with id ID has been validated

func (ValidBlock) GetChannel

func (ValidBlock) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent

type ValidTx

type ValidTx struct {
	ID    string
	Valid bool
}

ValidTx signals that the transaction with id ID has been validated

func (ValidTx) GetChannel

func (ValidTx) GetChannel() ChannelID

GetChannel gets the message type which means on which this message should be sent