options

Documentation

Overview

Package options provides some option configurations for the relay.

None of this package is actually in use, and the skip event function has not been implemented. In theory, this could be used for something but it currently isn't.

Index

• type O
  • func WithSkipEventFunc(skipEventFunc func(*event.E) bool) O
• type SkipEventFunc
• type T
  • func Default() *T

Types

type O

type O func(*T)

O is a function that processes an options.T.

func WithSkipEventFunc

func WithSkipEventFunc(skipEventFunc func(*event.E) bool) O

WithSkipEventFunc is an options.T generator that adds a function to skip events.

type SkipEventFunc

type SkipEventFunc func(*event.E) bool

type T

type T struct {
	// SkipEventFunc is in theory a function to test whether an event should not
	// be sent in response to a query.
	SkipEventFunc
}

T is a collection of options.

func Default

func Default() *T

Default returns an uninitialised options.T.