http

package

v0.4.11 Latest Latest Go to latest Published: Nov 22, 2017 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dms3-fs/go-fs-cmds

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewHandler(ctx cmds.Context, root *cmds.Command, cfg *ServerConfig) http.Handler
func Parse(r *http.Request, root *cmds.Command) (cmds.Request, error)
type Client
- func NewClient(address string) Client
type Handler
- func (i Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type MultiFileReader
- func NewMultiFileReader(file files.File, form bool) *MultiFileReader
- func (mfr *MultiFileReader) Boundary() string
- func (mfr *MultiFileReader) Read(buf []byte) (written int, err error)
type Response
type ResponseEmitter
- func NewFlushForwarder(r cmds.ResponseEmitter, f http.Flusher) ResponseEmitter
- func NewResponseEmitter(w http.ResponseWriter, method string, req cmds.Request) ResponseEmitter
type ServerConfig
- func NewServerConfig() *ServerConfig

Constants ¶

View Source

const (
	ApiUrlFormat = "http://%s%s/%s?%s"
	ApiPath      = "/api/v0" // TODO: make configurable
)

View Source

const (
	ACAOrigin      = "Access-Control-Allow-Origin"
	ACAMethods     = "Access-Control-Allow-Methods"
	ACACredentials = "Access-Control-Allow-Credentials"
)

View Source

const (
	StreamErrHeader = "X-Stream-Error"
)

Variables ¶

View Source

var AllowedExposedHeaders = strings.Join(AllowedExposedHeadersArr, ", ")

View Source

var AllowedExposedHeadersArr = []string{streamHeader, channelHeader, extraContentLengthHeader}

View Source

var (
	ErrNotFound = errors.New("404 page not found")
)

View Source

var (
	HeadRequest = fmt.Errorf("HEAD request")
)

View Source

var (
	MIMEEncodings = map[string]cmds.EncodingType{
		"application/json": cmds.JSON,
		"application/xml":  cmds.XML,
		"text/plain":       cmds.Text,
	}
)

View Source

var OptionSkipMap = map[string]bool{
	"api": true,
}

Functions ¶

func NewHandler ¶

func NewHandler(ctx cmds.Context, root *cmds.Command, cfg *ServerConfig) http.Handler

func Parse ¶

func Parse(r *http.Request, root *cmds.Command) (cmds.Request, error)

Parse parses the data in a http.Request and returns a command Request object

Types ¶

type Client ¶

type Client interface {
	Send(req cmds.Request) (cmds.Response, error)
}

Client is the commands HTTP client interface.

func NewClient ¶

func NewClient(address string) Client

type Handler ¶

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

The Handler struct is funny because we want to wrap our internal handler with CORS while keeping our fields.

func (Handler) ServeHTTP ¶

func (i Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type MultiFileReader ¶

type MultiFileReader struct {
	io.Reader
	// contains filtered or unexported fields
}

MultiFileReader reads from a `commands.File` (which can be a directory of files or a regular file) as HTTP multipart encoded data.

func NewMultiFileReader ¶

func NewMultiFileReader(file files.File, form bool) *MultiFileReader

NewMultiFileReader constructs a MultiFileReader. `file` can be any `commands.File`. If `form` is set to true, the multipart data will have a Content-Type of 'multipart/form-data', if `form` is false, the Content-Type will be 'multipart/mixed'.

func (*MultiFileReader) Boundary ¶

func (mfr *MultiFileReader) Boundary() string

Boundary returns the boundary string to be used to separate files in the multipart data

func (*MultiFileReader) Read ¶

func (mfr *MultiFileReader) Read(buf []byte) (written int, err error)

type Response ¶

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

func (*Response) Error ¶

func (res *Response) Error() *cmdkit.Error

func (*Response) Length ¶

func (res *Response) Length() uint64

func (*Response) Next ¶

func (res *Response) Next() (interface{}, error)

func (*Response) RawNext ¶ added in v0.4.7

func (res *Response) RawNext() (interface{}, error)

func (*Response) Request ¶

func (res *Response) Request() cmds.Request

type ResponseEmitter ¶

type ResponseEmitter interface {
	cmds.ResponseEmitter
	http.Flusher
}

func NewFlushForwarder ¶

func NewFlushForwarder(r cmds.ResponseEmitter, f http.Flusher) ResponseEmitter

func NewResponseEmitter ¶

func NewResponseEmitter(w http.ResponseWriter, method string, req cmds.Request) ResponseEmitter

NewResponeEmitter returns a new ResponseEmitter.

type ServerConfig ¶

type ServerConfig struct {
	// Headers is an optional map of headers that is written out.
	Headers map[string][]string
	// contains filtered or unexported fields
}

func NewServerConfig ¶

func NewServerConfig() *ServerConfig

func (ServerConfig) AllowedMethods ¶

func (cfg ServerConfig) AllowedMethods() []string

func (ServerConfig) AllowedOrigins ¶

func (cfg ServerConfig) AllowedOrigins() []string

func (*ServerConfig) AppendAllowedOrigins ¶

func (cfg *ServerConfig) AppendAllowedOrigins(origins ...string)

func (*ServerConfig) SetAllowCredentials ¶

func (cfg *ServerConfig) SetAllowCredentials(flag bool)

func (*ServerConfig) SetAllowedMethods ¶

func (cfg *ServerConfig) SetAllowedMethods(methods ...string)

func (*ServerConfig) SetAllowedOrigins ¶

func (cfg *ServerConfig) SetAllowedOrigins(origins ...string)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL