appdata

Documentation

Index

• type AllSet
• type Handler
• type HandlerRegistry
  • func NewHandlerRegistry() *HandlerRegistry
  • func (p *HandlerRegistry) HandlerForType(dataType string) (Handler, bool)
  • func (p *HandlerRegistry) Register(dataType string, handler Handler) error
• type Option
  • func WithPeerFilter(filter PeerFilter) Option
• type PeerFilter
• type Request
  • func NewRequest(dataType string, payload []byte) *Request
• type Responder
• type ResponseHandler
• type Retriever
  • func NewRetriever(channelID string, gossip gossipService, gossipMaxAttempts, gossipMaxPeers int) *Retriever
  • func (r *Retriever) Retrieve(ctxt context.Context, request *Request, responseHandler ResponseHandler, ...) (extcommon.Values, error)

Types

type AllSet

type AllSet func(values extcommon.Values) bool

AllSet returns true if all of the values have been set

type Handler

type Handler func(channelID string, request *gproto.AppDataRequest, responder Responder)

Handler handles an application data request

type HandlerRegistry

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

HandlerRegistry manages handlers for application-specific Gossip messages

func NewHandlerRegistry

func NewHandlerRegistry() *HandlerRegistry

NewHandlerRegistry returns a new HandlerRegistry

func (*HandlerRegistry) HandlerForType

func (p *HandlerRegistry) HandlerForType(dataType string) (Handler, bool)

HandlerForType returns the handler for the given data type

func (*HandlerRegistry) Register

func (p *HandlerRegistry) Register(dataType string, handler Handler) error

Register registers a handler for the given data type. Only one handler may be registered per data type, otherwise an error results

type Option

type Option func(options *options)

Option is a retriever option

func WithPeerFilter

func WithPeerFilter(filter PeerFilter) Option

WithPeerFilter sets a peer filter

type PeerFilter

type PeerFilter = func(*extdiscovery.Member) bool

PeerFilter returns true to include the peer in the Gossip request

type Request

type Request struct {
	DataType string
	Payload  []byte
}

Request contains an application data request

func NewRequest

func NewRequest(dataType string, payload []byte) *Request

NewRequest returns a new application data request

type Responder

type Responder interface {
	Respond(data []byte)
}

Responder responds to data requests

type ResponseHandler

type ResponseHandler func(response []byte) (extcommon.Values, error)

ResponseHandler handles the response to retrieved data

type Retriever

type Retriever struct {
	*extdiscovery.Discovery
	// contains filtered or unexported fields
}

Retriever retrieves data from one or more peers on a channel

func NewRetriever

func NewRetriever(channelID string, gossip gossipService, gossipMaxAttempts, gossipMaxPeers int) *Retriever

NewRetriever returns a new application data retriever

func (*Retriever) Retrieve

func (r *Retriever) Retrieve(ctxt context.Context, request *Request, responseHandler ResponseHandler, allSet AllSet, opts ...Option) (extcommon.Values, error)

Retrieve retrieves application data from one or more peers