mps

Documentation

Index

• Variables
• type ClientOpt
• type FeedPacket
• type FeedType
• type MPS
  • func New(pool txSub, bc blockchain, logger log.Logger) *MPS
  • func (s *MPS) Start() error
  • func (s *MPS) Stop() error
• type Remote
  • func NewRemote(c *websocket.Conn, logger log.Logger) *Remote
  • func (r *Remote) FeedBlockedTxHash(hashes []common.Hash) error
  • func (r *Remote) FeedChainConfig(config *params.ChainConfig) error
  • func (r *Remote) FeedNewTx(txsWithSender TxsWithSender) error
  • func (r *Remote) FeedResponse(id int, ok bool, msg string) error
  • func (r *Remote) RecvLoop() error
  • func (r *Remote) Serve(cfg *params.ChainConfig) error
  • func (r *Remote) Stop()
• type RequestPacket
• type ResponsePacket
• type Topic
• type TxsWithSender

Variables

var ErrConnClosed = errors.New("ws conn closed")

Types

type ClientOpt

type ClientOpt int

const (
	ClientOptSubscribe ClientOpt = iota
	ClientOptUnsubscribe
)

type FeedPacket

type FeedPacket struct {
	Type FeedType `json:"type"`
	Data []byte   `json:"data"`
}

FeedPacket is the packet sent to mps client

type FeedType

type FeedType int

const (
	FeedTypeChainConfig FeedType = iota
	FeedTypeTransactions
	FeedTypeBlockedTxHashes
	FeedTypeResponse // response to client subscription requests
)

type MPS

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

MPS (Message Pushing Service) is designed to be used as a service embedded into go-ethereum.

func New

func New(pool txSub, bc blockchain, logger log.Logger) *MPS

func (*MPS) Start

func (s *MPS) Start() error

func (*MPS) Stop

func (s *MPS) Stop() error

type Remote

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

Remote represents one conn instance

func NewRemote

func NewRemote(c *websocket.Conn, logger log.Logger) *Remote

func (*Remote) FeedBlockedTxHash

func (r *Remote) FeedBlockedTxHash(hashes []common.Hash) error

FeedBlockedTxHash relay new blocked tx hash to clients

func (*Remote) FeedChainConfig

func (r *Remote) FeedChainConfig(config *params.ChainConfig) error

func (*Remote) FeedNewTx

func (r *Remote) FeedNewTx(txsWithSender TxsWithSender) error

FeedNewTx relay new tx event to clients

func (*Remote) FeedResponse

func (r *Remote) FeedResponse(id int, ok bool, msg string) error

FeedResponse respond to client requests

func (*Remote) RecvLoop

func (r *Remote) RecvLoop() error

func (*Remote) Serve

func (r *Remote) Serve(cfg *params.ChainConfig) error

Serve blocked until conn closed

func (*Remote) Stop

func (r *Remote) Stop()

type RequestPacket

type RequestPacket struct {
	Id    int       `json:"id"`
	Op    ClientOpt `json:"opt"`
	Topic Topic     `json:"topic"`
}

type ResponsePacket

type ResponsePacket struct {
	// quest id
	Id      int    `json:"id"`
	Ok      bool   `json:"ok"`
	Message string `json:"message"`
}

type Topic

type Topic string

const (
	TopicNewTx           Topic = "newTx"
	TopicBlockedTxHashes       = "blockedTxHashes"
)

type TxsWithSender

type TxsWithSender struct {
	Txs     types.Transactions `json:"txs"`
	Senders []*common.Address  `json:"senders"`
}

TxsWithSender is a wrapper of transactions and their senders, used to send txs packet to mps client