rest

Documentation

Index

• Constants
• type Client
  • func NewClient(url *url.URL, newCustomTransport func() *http.Transport, ...) (*Client, error)
  • func (c *Client) Call(method string, values url.Values, body io.Reader, length int64) (reply io.ReadCloser, err error)
  • func (c *Client) CallWithContext(ctx context.Context, method string, values url.Values, body io.Reader, ...) (reply io.ReadCloser, err error)
  • func (c *Client) Close()
• type NetworkError
  • func (n *NetworkError) Error() string

Constants

const DefaultRESTTimeout = 1 * time.Minute

DefaultRESTTimeout - default RPC timeout is one minute.

Types

type Client

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

Client - http based RPC client.

func NewClient

func NewClient(url *url.URL, newCustomTransport func() *http.Transport, newAuthToken func() string) (*Client, error)

NewClient - returns new REST client.

func (*Client) Call

func (c *Client) Call(method string, values url.Values, body io.Reader, length int64) (reply io.ReadCloser, err error)

Call - make a REST call.

func (*Client) CallWithContext

func (c *Client) CallWithContext(ctx context.Context, method string, values url.Values, body io.Reader, length int64) (reply io.ReadCloser, err error)

CallWithContext - make a REST call with context.

func (*Client) Close

func (c *Client) Close()

Close closes all idle connections of the underlying http client

type NetworkError

type NetworkError struct {
	Err error
}

NetworkError - error type in case of errors related to http/transport for ex. connection refused, connection reset, dns resolution failure etc. All errors returned by storage-rest-server (ex errFileNotFound, errDiskNotFound) are not considered to be network errors.

func (*NetworkError) Error

func (n *NetworkError) Error() string