policy

Documentation

Index

• type Policy
  • func New(cfg config.Policy) (*Policy, error)
  • func (p *Policy) Allow(peerID peer.ID) bool
  • func (p *Policy) Allowed(peerID peer.ID) bool
  • func (p *Policy) Block(peerID peer.ID) bool
  • func (p *Policy) Check(peerID peer.ID) (bool, bool)
  • func (p *Policy) Config(cfg config.Policy) error
  • func (p *Policy) ToConfig() config.Policy
  • func (p *Policy) Trusted(peerID peer.ID) bool

Types

type Policy

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

func New

func New(cfg config.Policy) (*Policy, error)

func (*Policy) Allow

func (p *Policy) Allow(peerID peer.ID) bool

Allow alters the policy to allow the specified peer. Returns true if the policy needed to be updated.

func (*Policy) Allowed

func (p *Policy) Allowed(peerID peer.ID) bool

Allowed returns true if the policy allows the peer to index content. This check does not check whether the peer is trusted. An allowed peer must still be verified.

func (*Policy) Block

func (p *Policy) Block(peerID peer.ID) bool

Block alters the policy to not allow the specified peer. Returns true if the policy needed to be updated.

func (*Policy) Check

func (p *Policy) Check(peerID peer.ID) (bool, bool)

Check returns whether the two bool values. The fisrt is true if the peer is allowed. The second is true if the peer is allowed and is trusted (does not require verification).

func (*Policy) Config

func (p *Policy) Config(cfg config.Policy) error

Config applies the configuration.

func (*Policy) ToConfig

func (p *Policy) ToConfig() config.Policy

ToConfig converts a Policy into a config.Policy.

func (*Policy) Trusted

func (p *Policy) Trusted(peerID peer.ID) bool

Trusted returns true if the peer is explicitly trusted. A trusted peer is allowed to register without requiring verification.