timeoutwr

Documentation

Overview

Package timeoutwr provides a wrapper for RBLs that sets a timeout in the check resquests.

This package is a work in progress and makes no API stability promises.

Index

• Constants
• func Builder(timeout time.Duration) xlistd.BuildWrapperFn
• type Wrapper
  • func New(list xlistd.List, timeout time.Duration) *Wrapper
  • func (w *Wrapper) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)
  • func (w *Wrapper) Class() string
  • func (w *Wrapper) ID() string
  • func (w *Wrapper) Ping() error
  • func (w *Wrapper) Resources(ctx context.Context) ([]xlist.Resource, error)

Constants

const DefaultTimeout = 1 * time.Second

DefaultTimeout sets default timeout in construction.

const WrapperClass = "timeout"

WrapperClass registered.

Functions

func Builder

func Builder(timeout time.Duration) xlistd.BuildWrapperFn

Builder returns a builder function.

Types

type Wrapper

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

Wrapper implements an xlistd.List wrapper for include a timeout in check requests.

func New

func New(list xlistd.List, timeout time.Duration) *Wrapper

New creates a Wrapper with timeout.

func (*Wrapper) Check

func (w *Wrapper) Check(ctx context.Context, name string, resource xlist.Resource) (xlist.Response, error)

Check implements xlist.Checker interface.

func (*Wrapper) Class

func (w *Wrapper) Class() string

Class implements xlistd.List interface.

func (*Wrapper) ID

func (w *Wrapper) ID() string

ID implements xlistd.List interface.

func (*Wrapper) Ping

func (w *Wrapper) Ping() error

Ping implements xlistd.List interface.

func (*Wrapper) Resources

func (w *Wrapper) Resources(ctx context.Context) ([]xlist.Resource, error)

Resources implements xlist.Checker interface.