interceptors

Documentation

Index

• func NewEpochStartMetaBlockInterceptor(args ArgsEpochStartMetaBlockInterceptor) (*epochStartMetaBlockInterceptor, error)
• func NewWhiteListDataVerifier(cacher storage.Cacher) (*whiteListDataVerifier, error)
• type ArgMultiDataInterceptor
• type ArgSingleDataInterceptor
• type ArgsEpochStartMetaBlockInterceptor
• type MultiDataInterceptor
  • func NewMultiDataInterceptor(arg ArgMultiDataInterceptor) (*MultiDataInterceptor, error)
  • func (mdi *MultiDataInterceptor) Close() error
  • func (mdi *MultiDataInterceptor) IsInterfaceNil() bool
  • func (mdi *MultiDataInterceptor) ProcessReceivedMessage(message p2p.MessageP2P, fromConnectedPeer core.PeerID, _ p2p.MessageHandler) error
  • func (mdi *MultiDataInterceptor) RegisterHandler(handler func(topic string, hash []byte, data interface{}))
  • func (mdi *MultiDataInterceptor) SetChunkProcessor(processor process.InterceptedChunksProcessor) error
  • func (bdi MultiDataInterceptor) SetInterceptedDebugHandler(handler process.InterceptedDebugger) error
• type SingleDataInterceptor
  • func NewSingleDataInterceptor(arg ArgSingleDataInterceptor) (*SingleDataInterceptor, error)
  • func (sdi *SingleDataInterceptor) Close() error
  • func (sdi *SingleDataInterceptor) IsInterfaceNil() bool
  • func (sdi *SingleDataInterceptor) ProcessReceivedMessage(message p2p.MessageP2P, fromConnectedPeer core.PeerID, _ p2p.MessageHandler) error
  • func (sdi *SingleDataInterceptor) RegisterHandler(handler func(topic string, hash []byte, data interface{}))
  • func (bdi SingleDataInterceptor) SetInterceptedDebugHandler(handler process.InterceptedDebugger) error

Functions

func NewEpochStartMetaBlockInterceptor

func NewEpochStartMetaBlockInterceptor(args ArgsEpochStartMetaBlockInterceptor) (*epochStartMetaBlockInterceptor, error)

NewEpochStartMetaBlockInterceptor returns a new instance of epochStartMetaBlockInterceptor

func NewWhiteListDataVerifier

func NewWhiteListDataVerifier(cacher storage.Cacher) (*whiteListDataVerifier, error)

NewWhiteListDataVerifier returns a default data verifier

Types

type ArgMultiDataInterceptor

type ArgMultiDataInterceptor struct {
	Topic                string
	Marshalizer          marshal.Marshalizer
	DataFactory          process.InterceptedDataFactory
	Processor            process.InterceptorProcessor
	Throttler            process.InterceptorThrottler
	AntifloodHandler     process.P2PAntifloodHandler
	WhiteListRequest     process.WhiteListHandler
	PreferredPeersHolder process.PreferredPeersHolderHandler
	CurrentPeerId        core.PeerID
}

ArgMultiDataInterceptor is the argument for the multi-data interceptor

type ArgSingleDataInterceptor

type ArgSingleDataInterceptor struct {
	Topic                string
	DataFactory          process.InterceptedDataFactory
	Processor            process.InterceptorProcessor
	Throttler            process.InterceptorThrottler
	AntifloodHandler     process.P2PAntifloodHandler
	WhiteListRequest     process.WhiteListHandler
	PreferredPeersHolder process.PreferredPeersHolderHandler
	CurrentPeerId        core.PeerID
}

ArgSingleDataInterceptor is the argument for the single-data interceptor

type ArgsEpochStartMetaBlockInterceptor

type ArgsEpochStartMetaBlockInterceptor struct {
	Marshalizer               marshal.Marshalizer
	Hasher                    hashing.Hasher
	NumConnectedPeersProvider process.NumConnectedPeersProvider
	ConsensusPercentage       int
}

ArgsEpochStartMetaBlockInterceptor holds the arguments needed for creating a new epochStartMetaBlockInterceptor

type MultiDataInterceptor

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

MultiDataInterceptor is used for intercepting packed multi data

func NewMultiDataInterceptor

func NewMultiDataInterceptor(arg ArgMultiDataInterceptor) (*MultiDataInterceptor, error)

NewMultiDataInterceptor hooks a new interceptor for packed multi data

func (*MultiDataInterceptor) Close

func (mdi *MultiDataInterceptor) Close() error

Close will call the chunk processor's close method

func (*MultiDataInterceptor) IsInterfaceNil

func (mdi *MultiDataInterceptor) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*MultiDataInterceptor) ProcessReceivedMessage

func (mdi *MultiDataInterceptor) ProcessReceivedMessage(message p2p.MessageP2P, fromConnectedPeer core.PeerID, _ p2p.MessageHandler) error

ProcessReceivedMessage is the callback func from the p2p.Messenger and will be called each time a new message was received (for the topic this validator was registered to)

func (*MultiDataInterceptor) RegisterHandler

func (mdi *MultiDataInterceptor) RegisterHandler(handler func(topic string, hash []byte, data interface{}))

RegisterHandler registers a callback function to be notified on received data

func (*MultiDataInterceptor) SetChunkProcessor

func (mdi *MultiDataInterceptor) SetChunkProcessor(processor process.InterceptedChunksProcessor) error

SetChunkProcessor sets the intercepted chunks processor

func (MultiDataInterceptor) SetInterceptedDebugHandler

func (bdi MultiDataInterceptor) SetInterceptedDebugHandler(handler process.InterceptedDebugger) error

SetInterceptedDebugHandler will set a new intercepted debug handler

type SingleDataInterceptor

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

SingleDataInterceptor is used for intercepting packed multi data

func NewSingleDataInterceptor

func NewSingleDataInterceptor(arg ArgSingleDataInterceptor) (*SingleDataInterceptor, error)

NewSingleDataInterceptor hooks a new interceptor for single data

func (*SingleDataInterceptor) Close

func (sdi *SingleDataInterceptor) Close() error

Close returns nil

func (*SingleDataInterceptor) IsInterfaceNil

func (sdi *SingleDataInterceptor) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*SingleDataInterceptor) ProcessReceivedMessage

func (sdi *SingleDataInterceptor) ProcessReceivedMessage(message p2p.MessageP2P, fromConnectedPeer core.PeerID, _ p2p.MessageHandler) error

ProcessReceivedMessage is the callback func from the p2p.Messenger and will be called each time a new message was received (for the topic this validator was registered to)

func (*SingleDataInterceptor) RegisterHandler

func (sdi *SingleDataInterceptor) RegisterHandler(handler func(topic string, hash []byte, data interface{}))

RegisterHandler registers a callback function to be notified on received data

func (SingleDataInterceptor) SetInterceptedDebugHandler

func (bdi SingleDataInterceptor) SetInterceptedDebugHandler(handler process.InterceptedDebugger) error

SetInterceptedDebugHandler will set a new intercepted debug handler