config

Documentation

Index

• Variables
• func NewReaderFromConfig(r ea.ByteBlockDiscardReader, config *FecConfig) (ea2.MessageReader, error)
• func NewWriterFromConfig(w io.Writer, config *FecConfig) (ea2.MessageWriter, error)
• type AlgorithmE
• type FecConfig
  • func (inst *FecConfig) FromContext(nameTransf config.NameTransformFunc, ctx *cli.Context) (nMessages int)
  • func (inst *FecConfig) ToCliFlags(nameTransf config.NameTransformFunc, envVarNameTransf config.NameTransformFunc) []cli.Flag
  • func (inst *FecConfig) Validate(force bool) (nMessages int)

Variables

var AlgorithmResolveFunc = config.GenerateResolverFunc(AlgorithmToString[:], true)

var AlgorithmToString = [AlgorithmMax + 1]string{
	"passthrough",
	"golay24",
}

Functions

func NewReaderFromConfig

func NewReaderFromConfig(r ea.ByteBlockDiscardReader, config *FecConfig) (ea2.MessageReader, error)

func NewWriterFromConfig

func NewWriterFromConfig(w io.Writer, config *FecConfig) (ea2.MessageWriter, error)

Types

type AlgorithmE

type AlgorithmE uint16

const (
	AlgorithmPassthrough AlgorithmE = 0
	AlgorithmGolay24     AlgorithmE = 1
	AlgorithmMax         AlgorithmE = 1
)

type FecConfig

type FecConfig struct {
	FecAlgorithm                    uint16 `json:"algorithm"`
	NAnchorBytes                    uint8  `json:"nAnchorBytes"`
	AnchorMaxHammingDistPerByteIncl uint8  `json:"anchorMaxHammingDistPerByteIncl"`
	MaxMessageSize                  uint32 `json:"maxMessageSize"`
	// contains filtered or unexported fields
}

func (*FecConfig) FromContext

func (inst *FecConfig) FromContext(nameTransf config.NameTransformFunc, ctx *cli.Context) (nMessages int)

func (*FecConfig) ToCliFlags

func (inst *FecConfig) ToCliFlags(nameTransf config.NameTransformFunc, envVarNameTransf config.NameTransformFunc) []cli.Flag

func (*FecConfig) Validate

func (inst *FecConfig) Validate(force bool) (nMessages int)