source

Documentation

Index

• Constants
• Variables
• func CanonicalHeaderKey(s string) string
• func CheckResponseCode(respCode int, allowed []int) error
• func GetContentLength(request *Request) (int64, error)
• func GetLastModified(request *Request) (int64, error)
• func IsExpired(request *Request, info *ExpireInfo) (bool, error)
• func IsNoClientFoundError(err error) bool
• func IsResourceNotReachableError(err error) bool
• func IsSupportRange(request *Request) (bool, error)
• func List(request *Request) ([]*url.URL, error)
• func ListClients() []string
• func Register(scheme string, resourceClient ResourceClient, adaptor requestAdapter, ...) error
• func RequestEq(url string) gomock.Matcher
• func UnRegister(scheme string)
• func UpdatePluginDir(pluginDir string)
• func WithContentLength(length int64) func(*Response)
• func WithExpireInfo(info ExpireInfo) func(*Response)
• func WithHeader(header map[string]string) func(*Response)
• func WithStatus(code int, status string) func(*Response)
• func WithValidate(validate func() error) func(*Response)
• type ClientManager
  • func NewManager() ClientManager
• type ExpireInfo
• type Header
  • func (h Header) Add(key, value string)
  • func (h Header) Clone() Header
  • func (h Header) Del(key string)
  • func (h Header) Get(key string) string
  • func (h Header) Set(key, value string)
  • func (h Header) Values(key string) []string
• type Hook
• type Option
• type Request
  • func NewRequest(rawURL string) (*Request, error)
  • func NewRequestWithContext(ctx context.Context, rawURL string, header map[string]string) (*Request, error)
  • func NewRequestWithHeader(rawURL string, header map[string]string) (*Request, error)
  • func (r *Request) Clone(ctx context.Context) *Request
  • func (r *Request) Context() context.Context
  • func (r *Request) WithContext(ctx context.Context) *Request
• type ResourceClient
  • func LoadPlugin(dir, scheme string) (ResourceClient, error)
• type ResourceLister
• type Response
  • func Download(request *Request) (*Response, error)
  • func NewResponse(rc io.ReadCloser, opts ...func(*Response)) *Response
  • func (resp *Response) ExpireInfo() ExpireInfo
• type UnexpectedStatusCodeError
  • func (e UnexpectedStatusCodeError) Error() string
  • func (e UnexpectedStatusCodeError) Got() int

Constants

const (
	LastModified    = "X-Dragonfly-Last-Modified"
	IfModifiedSince = "X-Dragonfly-If-Modified-Since"
	ETag            = "X-Dragonfly-ETag"
	IfNoneMatch     = "X-Dragonfly-If-None-Match"
	Range           = "X-Dragonfly-Range" // startIndex-endIndex
)

const LastModifiedLayout = "Mon, 02 Jan 2006 15:04:05 GMT"

const (
	UnknownSourceFileLen = -2
)

Variables

var (
	// ErrResourceNotReachable represents the url resource is a not reachable.
	ErrResourceNotReachable = errors.New("resource is not reachable")

	// ErrNoClientFound represents no source client to resolve url
	ErrNoClientFound = errors.New("no source client found")

	// ErrClientNotSupportList represents the source client not support list action
	ErrClientNotSupportList = errors.New("source client not support list")
)

Functions

func CanonicalHeaderKey

func CanonicalHeaderKey(s string) string

func CheckResponseCode

func CheckResponseCode(respCode int, allowed []int) error

CheckResponseCode returns UnexpectedStatusError if the given response code is not one of the allowed status codes; otherwise nil.

func GetContentLength

func GetContentLength(request *Request) (int64, error)

func GetLastModified

func GetLastModified(request *Request) (int64, error)

func IsExpired

func IsExpired(request *Request, info *ExpireInfo) (bool, error)

func IsNoClientFoundError

func IsNoClientFoundError(err error) bool

func IsResourceNotReachableError

func IsResourceNotReachableError(err error) bool

func IsSupportRange

func IsSupportRange(request *Request) (bool, error)

func List

func List(request *Request) ([]*url.URL, error)

func ListClients

func ListClients() []string

func Register

func Register(scheme string, resourceClient ResourceClient, adaptor requestAdapter, hooks ...Hook) error

func RequestEq

func RequestEq(url string) gomock.Matcher

RequestEq for gomock

func UnRegister

func UnRegister(scheme string)

func UpdatePluginDir

func UpdatePluginDir(pluginDir string)

func WithContentLength

func WithContentLength(length int64) func(*Response)

func WithExpireInfo

func WithExpireInfo(info ExpireInfo) func(*Response)

func WithHeader

func WithHeader(header map[string]string) func(*Response)

func WithStatus

func WithStatus(code int, status string) func(*Response)

func WithValidate

func WithValidate(validate func() error) func(*Response)

Types

type ClientManager

type ClientManager interface {
	// Register registers a source client with scheme
	Register(scheme string, resourceClient ResourceClient, adapter requestAdapter, hook ...Hook) error

	// UnRegister revoke a source client from manager
	UnRegister(scheme string)

	// GetClient gets a source client by scheme
	GetClient(scheme string, options ...Option) (ResourceClient, bool)

	// ListClients lists all supported client scheme
	ListClients() []string
}

func NewManager

func NewManager() ClientManager

type ExpireInfo

type ExpireInfo struct {
	LastModified string // Mon, 02 Jan 2006 15:04:05 GMT
	ETag         string
}

type Header

type Header map[string][]string

A Header represents the key-value pairs in a Dragonfly source header.

The keys should be in canonical form, as returned by CanonicalHeaderKey.

func (Header) Add

func (h Header) Add(key, value string)

Add adds the key, value pair to the header. It appends to any existing values associated with key. The key is case insensitive; it is canonicalized by CanonicalHeaderKey.

func (Header) Clone

func (h Header) Clone() Header

Clone returns a copy of h or nil if h is nil.

func (Header) Del

func (h Header) Del(key string)

Del deletes the values associated with key. The key is case insensitive; it is canonicalized by CanonicalHeaderKey.

func (Header) Get

func (h Header) Get(key string) string

Get gets the first value associated with the given key. If there are no values associated with the key, Get returns "". It is case insensitive; textproto.CanonicalMIMEHeaderKey is used to canonicalize the provided key. To use non-canonical keys, access the map directly.

func (Header) Set

func (h Header) Set(key, value string)

Set sets the header entries associated with key to the single element value. It replaces any existing values associated with key. The key is case insensitive; it is canonicalized by textproto.CanonicalMIMEHeaderKey. To use non-canonical keys, assign to the map directly.

func (Header) Values

func (h Header) Values(key string) []string

Values returns all values associated with the given key. It is case insensitive; textproto.CanonicalMIMEHeaderKey is used to canonicalize the provided key. To use non-canonical keys, access the map directly. The returned slice is not a copy.

type Hook

type Hook interface {
	BeforeRequest(request *Request) error
	AfterResponse(response *Response) error
}

Hook TODO hook

type Option

type Option func(c *clientManager)

type Request

type Request struct {
	URL    *url.URL
	Header Header
	// contains filtered or unexported fields
}

func NewRequest

func NewRequest(rawURL string) (*Request, error)

func NewRequestWithContext

func NewRequestWithContext(ctx context.Context, rawURL string, header map[string]string) (*Request, error)

func NewRequestWithHeader

func NewRequestWithHeader(rawURL string, header map[string]string) (*Request, error)

func (*Request) Clone

func (r *Request) Clone(ctx context.Context) *Request

Clone returns a deep copy of r with its context changed to ctx. The provided ctx must be non-nil.

For an outgoing client request, the context controls the entire lifetime of a request and its response: obtaining a connection, sending the request, and reading the response headers and body.

func (*Request) Context

func (r *Request) Context() context.Context

Context returns the request's context. To change the context, use WithContext.

The returned context is always non-nil; it defaults to the background context.

For outgoing client requests, the context controls cancellation.

For incoming server requests, the context is canceled when the client's connection closes, the request is canceled (with HTTP/2), or when the ServeHTTP method returns.

func (*Request) WithContext

func (r *Request) WithContext(ctx context.Context) *Request

WithContext returns a shallow copy of r with its context changed to ctx. The provided ctx must be non-nil.

For outgoing client request, the context controls the entire lifetime of a request and its response: obtaining a connection, sending the request, and reading the response headers and body.

To create a new request with a context, use NewRequestWithContext. To change the context of a request, such as an incoming request you want to modify before sending back out, use Request.Clone. Between those two uses, it's rare to need WithContext.

type ResourceClient

type ResourceClient interface {
	// GetContentLength get length of resource content
	// return source.UnknownSourceFileLen if response status is not StatusOK and StatusPartialContent
	GetContentLength(request *Request) (int64, error)

	// IsSupportRange checks if resource supports breakpoint continuation
	// return false if response status is not StatusPartialContent
	IsSupportRange(request *Request) (bool, error)

	// IsExpired checks if a resource received or stored is the same.
	// return false and non-nil err to prevent the source from exploding if
	// fails to get the result, it is considered that the source has not expired
	IsExpired(request *Request, info *ExpireInfo) (bool, error)

	// Download downloads from source
	Download(request *Request) (*Response, error)

	// GetLastModified gets last modified timestamp milliseconds of resource
	GetLastModified(request *Request) (int64, error)
}

ResourceClient defines the API interface to interact with source.

func LoadPlugin

func LoadPlugin(dir, scheme string) (ResourceClient, error)

type ResourceLister

type ResourceLister interface {
	List(request *Request) (urls []*url.URL, err error)
}

ResourceLister defines the interface to list all downloadable resources in request url

type Response

type Response struct {
	Status        string
	StatusCode    int
	Header        Header
	Body          io.ReadCloser
	ContentLength int64
	// validate this response is okay to transfer in p2p network, like status 200 or 206 in http is valid to do this,
	// otherwise return status code to original client
	Validate func() error
}

func Download

func Download(request *Request) (*Response, error)

func NewResponse

func NewResponse(rc io.ReadCloser, opts ...func(*Response)) *Response

func (*Response) ExpireInfo

func (resp *Response) ExpireInfo() ExpireInfo

type UnexpectedStatusCodeError

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

UnexpectedStatusCodeError is returned when a source responds with neither an error nor with a status code indicating success.

func (UnexpectedStatusCodeError) Error

func (e UnexpectedStatusCodeError) Error() string

Error implements interface error

func (UnexpectedStatusCodeError) Got

func (e UnexpectedStatusCodeError) Got() int

Got is the actual status code returned by source.