upstream

Documentation

Overview

Package upstream - maintain REQ/REP connection to clients this allow for push of blocks, transactions... as well as polling for out of sync conditions

Index

• type Upstream
  • func (u *Upstream) ActiveInPastSeconds(sec time.Duration) bool
  • func (u *Upstream) CachedRemoteDigestOfLocalHeight() blockdigest.Digest
  • func (u *Upstream) CachedRemoteHeight() uint64
  • func (u *Upstream) Client() zmqutil.ClientIntf
  • func (u *Upstream) Connect(address *util.Connection, serverPublicKey []byte) error
  • func (u *Upstream) ConnectedTo() *zmqutil.Connected
  • func (u *Upstream) Destroy()
  • func (u *Upstream) GetBlockData(blockNumber uint64) ([]byte, error)
  • func (u *Upstream) IsConnected() bool
  • func (u *Upstream) IsConnectedTo(serverPublicKey []byte) bool
  • func (u *Upstream) LocalHeight() uint64
  • func (u *Upstream) Name() string
  • func (u *Upstream) RemoteAddr() (string, error)
  • func (u *Upstream) RemoteDigestOfHeight(blockNumber uint64) (blockdigest.Digest, error)
  • func (u *Upstream) RemoteHeight() (uint64, error)
  • func (u *Upstream) ResetServer()
  • func (u *Upstream) ServerPublicKey() []byte
• type UpstreamIntf
  • func New(privateKey []byte, publicKey []byte, timeout time.Duration) (UpstreamIntf, error)

Types

type Upstream

type Upstream struct {
	sync.RWMutex

	UpstreamIntf
	// contains filtered or unexported fields
}

Upstream - structure to hold an upstream connection

func (*Upstream) ActiveInPastSeconds

func (u *Upstream) ActiveInPastSeconds(sec time.Duration) bool

ActiveInPastSeconds - active upstream in past seconds

func (*Upstream) CachedRemoteDigestOfLocalHeight

func (u *Upstream) CachedRemoteDigestOfLocalHeight() blockdigest.Digest

CachedRemoteDigestOfLocalHeight - cached remote digest of local block height

func (*Upstream) CachedRemoteHeight

func (u *Upstream) CachedRemoteHeight() uint64

CachedRemoteHeight - cached remote client height

func (*Upstream) Client

func (u *Upstream) Client() zmqutil.ClientIntf

Client - zmq client

func (*Upstream) Connect

func (u *Upstream) Connect(address *util.Connection, serverPublicKey []byte) error

Connect - connect (or reconnect) to a specific server

func (*Upstream) ConnectedTo

func (u *Upstream) ConnectedTo() *zmqutil.Connected

ConnectedTo - if registered return the connection data

func (*Upstream) Destroy

func (u *Upstream) Destroy()

Destroy - shutdown a connection and terminate its background processes

func (*Upstream) GetBlockData

func (u *Upstream) GetBlockData(blockNumber uint64) ([]byte, error)

GetBlockData - fetch block data from a specific block number

func (*Upstream) IsConnected

func (u *Upstream) IsConnected() bool

IsConnected - check if registered and have a valid connection

func (*Upstream) IsConnectedTo

func (u *Upstream) IsConnectedTo(serverPublicKey []byte) bool

IsConnectedTo - check the current destination

does not mean actually connected, as could be in a timeout and reconnect state

func (*Upstream) LocalHeight

func (u *Upstream) LocalHeight() uint64

LocalHeight - local block height

func (*Upstream) Name

func (u *Upstream) Name() string

Name - upstream name

func (*Upstream) RemoteAddr

func (u *Upstream) RemoteAddr() (string, error)

RemoteAddr - remote client address

func (*Upstream) RemoteDigestOfHeight

func (u *Upstream) RemoteDigestOfHeight(blockNumber uint64) (blockdigest.Digest, error)

RemoteDigestOfHeight - fetch block digest from a specific block number

func (*Upstream) RemoteHeight

func (u *Upstream) RemoteHeight() (uint64, error)

must have lock held before calling

func (*Upstream) ResetServer

func (u *Upstream) ResetServer()

ResetServer - clear Server side info of Zmq client for reusing the upstream

func (*Upstream) ServerPublicKey

func (u *Upstream) ServerPublicKey() []byte

ServerPublicKey - return the internal ZeroMQ client data

type UpstreamIntf

type UpstreamIntf interface {
	ActiveInPastSeconds(time.Duration) bool
	CachedRemoteDigestOfLocalHeight() blockdigest.Digest
	CachedRemoteHeight() uint64
	Client() zmqutil.ClientIntf
	Connect(*util.Connection, []byte) error
	ConnectedTo() *zmqutil.Connected
	Destroy()
	GetBlockData(uint64) ([]byte, error)
	IsConnectedTo([]byte) bool
	IsConnected() bool
	LocalHeight() uint64
	Name() string
	RemoteAddr() (string, error)
	RemoteDigestOfHeight(uint64) (blockdigest.Digest, error)
	RemoteHeight() (uint64, error)
	ResetServer()
	ServerPublicKey() []byte
}

func New

func New(privateKey []byte, publicKey []byte, timeout time.Duration) (UpstreamIntf, error)

New - create a connection to an upstream server