simpwebserv

README

simpwebserv

一个给go的http服务端框架

Documentation

Index

• Variables
• func PanicTrace() []byte
• type AppStruct
  • func App() *AppStruct
  • func (app *AppStruct) Register(function func(*Request) *Response, path string, includeBack bool)
  • func (app *AppStruct) Run(config Config)
  • func (app *AppStruct) SetDebugMode(onoff bool)
  • func (app *AppStruct) SetEnableConsoleLog(onoff bool)
  • func (app *AppStruct) SetEnableKeepAlive(onoff bool)
  • func (app *AppStruct) SetKeepAliveTimeout(timeout uint64)
  • func (app *AppStruct) SetTls(pemPath string, keyPath string) error
• type Config
• type Request
  • func (request *Request) ConnRead(buf []byte) (int, error)
  • func (request *Request) ConnReadUntil(spliter []byte, writer io.Writer, maxSize uint64) error
  • func (request *Request) ConnWrite(buf []byte) (int, error)
  • func (request *Request) DecodeCookie() map[string]string
  • func (request *Request) DecodeFormUrlEncoded() (map[string]string, error)
  • func (request *Request) DecodeUrlParameter() map[string]string
  • func (request *Request) RecvFile(storePath string, filename string, maxSize uint64) error
  • func (request *Request) SendFile(response *Response, path string, filename string)
  • func (request *Request) SendHeader(response *Response)
• type Response
  • func Build404DefaultResponse() *Response
  • func Build404Response() *Response
  • func Build500DefaultResponse() *Response
  • func BuildBasicResponse() *Response
  • func BuildStaticFileResponse(path string, contentType string) *Response
• type UrlNode

Variables

var (
	ErrBufferTooBig            = errors.New("buffer too big")
	ErrRequirementNotSatisfied = errors.New("requirement not satisfied")
)

Functions

func PanicTrace

func PanicTrace() []byte

Types

type AppStruct

type AppStruct struct {
	HTTPSConfig *tls.Config
	// contains filtered or unexported fields
}

func App

func App() *AppStruct

func (*AppStruct) Register

func (app *AppStruct) Register(function func(*Request) *Response, path string, includeBack bool)

func (*AppStruct) Run

func (app *AppStruct) Run(config Config)

func (*AppStruct) SetDebugMode

func (app *AppStruct) SetDebugMode(onoff bool)

func (*AppStruct) SetEnableConsoleLog

func (app *AppStruct) SetEnableConsoleLog(onoff bool)

func (*AppStruct) SetEnableKeepAlive

func (app *AppStruct) SetEnableKeepAlive(onoff bool)

func (*AppStruct) SetKeepAliveTimeout

func (app *AppStruct) SetKeepAliveTimeout(timeout uint64)

func (*AppStruct) SetTls

func (app *AppStruct) SetTls(pemPath string, keyPath string) error

type Config

type Config struct {
	Host                 string
	Port                 uint16
	UseTls               bool
	DebugMode            bool
	DisableConsoleLog    bool
	DisableKeepAlive     bool
	KeepAliveTimeout     time.Duration
	TlsPemPath           string
	TlsKeyPath           string
	MultiThreadAcceptNum uint16
}

type Request

type Request struct {
	Method       string
	Path         string
	UrlParameter string
	Protocol     string
	Host         string
	Header       map[string]string
	// contains filtered or unexported fields
}

func (*Request) ConnRead

func (request *Request) ConnRead(buf []byte) (int, error)

func (*Request) ConnReadUntil

func (request *Request) ConnReadUntil(spliter []byte, writer io.Writer, maxSize uint64) error

func (*Request) ConnWrite

func (request *Request) ConnWrite(buf []byte) (int, error)

func (*Request) DecodeCookie

func (request *Request) DecodeCookie() map[string]string

func (*Request) DecodeFormUrlEncoded

func (request *Request) DecodeFormUrlEncoded() (map[string]string, error)

func (*Request) DecodeUrlParameter

func (request *Request) DecodeUrlParameter() map[string]string

func (*Request) RecvFile

func (request *Request) RecvFile(storePath string, filename string, maxSize uint64) error

func (*Request) SendFile

func (request *Request) SendFile(response *Response, path string, filename string)

func (*Request) SendHeader

func (request *Request) SendHeader(response *Response)

type Response

type Response struct {
	Protocol      string
	Code          string
	CodeName      string
	Header        map[string]string
	Body          *bytes.Buffer
	SetCookieList []string
	// contains filtered or unexported fields
}

func Build404DefaultResponse

func Build404DefaultResponse() *Response

func Build404Response

func Build404Response() *Response

func Build500DefaultResponse

func Build500DefaultResponse() *Response

func BuildBasicResponse

func BuildBasicResponse() *Response

func BuildStaticFileResponse

func BuildStaticFileResponse(path string, contentType string) *Response

type UrlNode

type UrlNode struct {
	NextLayer   map[string]*UrlNode
	IncludeBack bool
	Function    func(*Request) *Response
}