spartan

Documentation

Index

• Constants
• Variables
• func ClientError(err error) *types.Response
• func GetRequestBody(request *types.Request) io.Reader
• func GetRequestContentLength(request *types.Request) int
• func NewResponseReader(response *types.Response) types.ResponseReader
• func NewServer(ctx context.Context, hostname string, network string, address string, ...) (types.Server, error)
• func ParseRequest(rdr io.Reader) (*types.Request, int, error)
• func ParseResponse(rdr io.Reader) (*types.Response, error)
• func Redirect(url string) *types.Response
• func ServerError(err error) *types.Response
• func Success(mediatype string, body io.Reader) *types.Response
• type Client
  • func NewClient() Client
  • func (c Client) Fetch(ctx context.Context, url string) (*types.Response, error)
  • func (c Client) IsRedirect(response *types.Response) bool
  • func (c Client) RoundTrip(ctx context.Context, request *types.Request) (*types.Response, error)

Constants

const (
	StatusSuccess     types.Status = 2
	StatusRedirect    types.Status = 3
	StatusClientError types.Status = 4
	StatusServerError types.Status = 5
)

The spartan response types.

const DefaultMaxRedirects int = 2

DefaultMaxRedirects is the number of chained redirects a Client will perform for a single request by default. This can be changed by altering the MaxRedirects field.

Variables

var (
	// InvalidRequestLine indicates a malformed first-line of a spartan request.
	InvalidRequestLine = errors.New("invalid request line")

	// InvalidRequestLineEnding says that a spartan request's first line wasn't terminated with CRLF.
	InvalidRequestLineEnding = errors.New("invalid request line ending")
)

var ExceededMaxRedirects = errors.New("spartan.Client: exceeded MaxRedirects")

var InvalidResponseHeaderLine = errors.New("Invalid response header line.")

InvalidResponseHeaderLine indicates a malformed spartan response line.

var InvalidResponseLineEnding = errors.New("Invalid response line ending.")

InvalidResponseLineEnding indicates that a spartan response header didn't end with "\r\n".

var ServerProtocol types.ServerProtocol = proto{}

Functions

func ClientError

func ClientError(err error) *types.Response

ClientError builds a "client error" spartan response.

func GetRequestBody

func GetRequestBody(request *types.Request) io.Reader

GetRequestBody returns a reader of the spartan request body.

It will return nil if the request has no body.

func GetRequestContentLength

func GetRequestContentLength(request *types.Request) int

GetRequestContentLength reads the remaining un-read number of bytes in a request body.

It will immediately return 0 if there is no request body.

func NewResponseReader

func NewResponseReader(response *types.Response) types.ResponseReader

NewResponseReader builds a reader for a response.

func NewServer

func NewServer(
	ctx context.Context,
	hostname string,
	network string,
	address string,
	handler types.Handler,
	baseLog logging.Logger,
) (types.Server, error)

NewServer builds a spartan server.

func ParseRequest

func ParseRequest(rdr io.Reader) (*types.Request, int, error)

ParseRequest parses a single spartan request and the indicated content-length from a reader.

If ther reader artument is a *bufio.Reader, it will only read a single line from it.

func ParseResponse

func ParseResponse(rdr io.Reader) (*types.Response, error)

func Redirect

func Redirect(url string) *types.Response

Redirect builds a spartan redirect response.

func ServerError

func ServerError(err error) *types.Response

ServerError builds a "server error" spartan response.

func Success

func Success(mediatype string, body io.Reader) *types.Response

Success builds a successful spartan response.

Types

type Client

type Client struct {
	MaxRedirects int
}

Client is used for sending spartan requests and receiving responses.

It carries no state and is reusable simultaneously by multiple goroutines.

The zero value is immediately usabble, but will not follow redirects.

func NewClient

func NewClient() Client

NewClient creates a spartan Client which will follow DefaultMaxRedirects.

func (Client) Fetch

func (c Client) Fetch(ctx context.Context, url string) (*types.Response, error)

Fetch parses a URL string and fetches the spartan resource.

It will resolve any redirects along the way, up to client.MaxRedirects.

func (Client) IsRedirect

func (c Client) IsRedirect(response *types.Response) bool

func (Client) RoundTrip

func (c Client) RoundTrip(ctx context.Context, request *types.Request) (*types.Response, error)

RoundTrip sends a single spartan request and returns its response.