sentinel

Documentation

Overview

Package sentinel defines type interfaces and other code used by sentinel.

Index

• type Commiter
• type ErrorValidation
  • func (e ErrorValidation) Error() string
  • func (e ErrorValidation) Unwrap() error
• type ErrorValidationKind
• type Pinner
• type Validator

Types

type Commiter

type Commiter interface {
	Add(ctx context.Context, cid cid.Cid) error
}

Commiter is responsible for adding commits at the head of the topic it serves.

type ErrorValidation

type ErrorValidation struct {
	Kind ErrorValidationKind
	Err  error
}

func (ErrorValidation) Error

func (e ErrorValidation) Error() string

func (ErrorValidation) Unwrap

func (e ErrorValidation) Unwrap() error

type ErrorValidationKind

type ErrorValidationKind uint

const (
	ErrorValidationKindUnknown ErrorValidationKind = iota
	ErrorValidationKindNotFound
	ErrorValidationKindInternal
	ErrorValidationKindIncorrectContent
)

type Pinner

type Pinner interface {
	Pin(ctx context.Context, cid cid.Cid) error
}

Pinner is responsible for pinning message - thus replicating it and making accessible to external consumers

type Validator

type Validator interface {
	Validate(ctx context.Context, cid cid.Cid) error
}

Validator validates message contents in sentinel. It should be implemented by topic owner.