messagerequester

Documentation

Index

• Constants
• type Events
• type MessageExistsFunc
• type MessageRequester
  • func New(missingMessages []message.ID, optionalOptions ...Option) *MessageRequester
  • func (requester *MessageRequester) RequestQueueSize() int
  • func (requester *MessageRequester) StartRequest(id message.ID)
  • func (requester *MessageRequester) StopRequest(id message.ID)
• type Option
  • func RetryInterval(interval time.Duration) Option
• type Options

Constants

const (
	// DefaultRetryInterval defines the Default Retry Interval of the message requester.
	DefaultRetryInterval = 10 * time.Second
)

Types

type Events

type Events struct {
	// Fired when a request for a given message should be sent.
	SendRequest *events.Event
	// MissingMessageAppeared is triggered when a message is actually present in the node's db although it was still being requested.
	MissingMessageAppeared *events.Event
}

Events represents events happening on a message requester.

type MessageExistsFunc

type MessageExistsFunc func(messageId message.ID) bool

MessageExistsFunc is a function that tells if a message exists.

type MessageRequester

type MessageRequester struct {
	Events Events
	// contains filtered or unexported fields
}

MessageRequester takes care of requesting messages.

func New

func New(missingMessages []message.ID, optionalOptions ...Option) *MessageRequester

New creates a new message requester.

func (*MessageRequester) RequestQueueSize

func (requester *MessageRequester) RequestQueueSize() int

RequestQueueSize returns the number of scheduled message requests.

func (*MessageRequester) StartRequest

func (requester *MessageRequester) StartRequest(id message.ID)

StartRequest initiates a regular triggering of the StartRequest event until it has been stopped using StopRequest.

func (*MessageRequester) StopRequest

func (requester *MessageRequester) StopRequest(id message.ID)

StopRequest stops requests for the given message to further happen.

type Option

type Option func(*Options)

Option is a function which inits an option.

func RetryInterval

func RetryInterval(interval time.Duration) Option

RetryInterval creates an option which sets the retry interval to the given value.

type Options

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

Options holds options for a message requester.