ghttp

func (*BodyReadCloser) Close ¶ added in v1.11.5

func (b *BodyReadCloser) Close() error

Close implements the io.ReadCloser interface.

func (*Client) BasicAuth ¶

func (c *Client) BasicAuth(user, pass string) *Client

BasicAuth is a chaining function, which sets HTTP basic authentication information for next request.

func (*Client) Clone ¶

func (c *Client) Clone() *Client

Clone clones current client and returns a new one.

func (*Client) Connect ¶

func (c *Client) Connect(url string, data ...interface{}) (*ClientResponse, error)

Connect send CONNECT request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) ConnectBytes ¶

func (c *Client) ConnectBytes(url string, data ...interface{}) []byte

ConnectBytes sends a CONNECT request, retrieves and returns the result content as bytes.

func (*Client) ConnectContent ¶

func (c *Client) ConnectContent(url string, data ...interface{}) string

ConnectContent is a convenience method for sending CONNECT request, which retrieves and returns the result content and automatically closes response object.

func (*Client) ContentJson ¶ added in v1.12.0

func (c *Client) ContentJson() *Client

ContentJson is a chaining function, which sets the HTTP content type as "application/json" for the next request.

Note that it also checks and encodes the parameter to JSON format automatically.

func (*Client) ContentType ¶ added in v1.12.0

func (c *Client) ContentType(contentType string) *Client

ContentType is a chaining function, which sets HTTP content type for the next request.

func (*Client) ContentXml ¶ added in v1.12.0

func (c *Client) ContentXml() *Client

ContentXml is a chaining function, which sets the HTTP content type as "application/xml" for the next request.

Note that it also checks and encodes the parameter to XML format automatically.

func (*Client) Cookie ¶ added in v1.12.0

func (c *Client) Cookie(m map[string]string) *Client

Cookie is a chaining function, which sets cookie items with map for next request.

func (*Client) Ctx ¶ added in v1.12.0

func (c *Client) Ctx(ctx context.Context) *Client

Ctx is a chaining function, which sets context for next request of this client.

func (*Client) Delete ¶

func (c *Client) Delete(url string, data ...interface{}) (*ClientResponse, error)

Delete send DELETE request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) DeleteBytes ¶

func (c *Client) DeleteBytes(url string, data ...interface{}) []byte

DeleteBytes sends a DELETE request, retrieves and returns the result content as bytes.

func (*Client) DeleteContent ¶

func (c *Client) DeleteContent(url string, data ...interface{}) string

DeleteContent is a convenience method for sending DELETE request, which retrieves and returns the result content and automatically closes response object.

func (*Client) DoRequest ¶

func (c *Client) DoRequest(method, url string, data ...interface{}) (resp *ClientResponse, err error)

DoRequest sends request with given HTTP method and data and returns the response object. Note that the response object MUST be closed if it'll be never used.

Note that it uses "multipart/form-data" as its Content-Type if it contains file uploading, else it uses "application/x-www-form-urlencoded". It also automatically detects the post content for JSON format, and for that it automatically sets the Content-Type as "application/json".

func (*Client) Get ¶

func (c *Client) Get(url string, data ...interface{}) (*ClientResponse, error)

Get send GET request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) GetBytes ¶

func (c *Client) GetBytes(url string, data ...interface{}) []byte

GetBytes sends a GET request, retrieves and returns the result content as bytes.

func (*Client) GetContent ¶

func (c *Client) GetContent(url string, data ...interface{}) string

GetContent is a convenience method for sending GET request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Head ¶

func (c *Client) Head(url string, data ...interface{}) (*ClientResponse, error)

Head send HEAD request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) HeadBytes ¶

func (c *Client) HeadBytes(url string, data ...interface{}) []byte

HeadBytes sends a HEAD request, retrieves and returns the result content as bytes.

func (*Client) HeadContent ¶

func (c *Client) HeadContent(url string, data ...interface{}) string

HeadContent is a convenience method for sending HEAD request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Header ¶ added in v1.12.0

func (c *Client) Header(m map[string]string) *Client

Header is a chaining function, which sets custom HTTP headers with map for next request.

func (*Client) HeaderRaw ¶ added in v1.12.0

func (c *Client) HeaderRaw(headers string) *Client

Header is a chaining function, which sets custom HTTP header using raw string for next request.

func (*Client) Options ¶

func (c *Client) Options(url string, data ...interface{}) (*ClientResponse, error)

Options send OPTIONS request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) OptionsBytes ¶

func (c *Client) OptionsBytes(url string, data ...interface{}) []byte

OptionsBytes sends a OPTIONS request, retrieves and returns the result content as bytes.

func (*Client) OptionsContent ¶

func (c *Client) OptionsContent(url string, data ...interface{}) string

OptionsContent is a convenience method for sending OPTIONS request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Patch ¶

func (c *Client) Patch(url string, data ...interface{}) (*ClientResponse, error)

Patch send PATCH request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) PatchBytes ¶

func (c *Client) PatchBytes(url string, data ...interface{}) []byte

PatchBytes sends a PATCH request, retrieves and returns the result content as bytes.

func (*Client) PatchContent ¶

func (c *Client) PatchContent(url string, data ...interface{}) string

PatchContent is a convenience method for sending PATCH request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Post ¶

func (c *Client) Post(url string, data ...interface{}) (*ClientResponse, error)

Post sends request using HTTP method POST and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) PostBytes ¶

func (c *Client) PostBytes(url string, data ...interface{}) []byte

PostBytes sends a POST request, retrieves and returns the result content as bytes.

func (*Client) PostContent ¶

func (c *Client) PostContent(url string, data ...interface{}) string

PostContent is a convenience method for sending POST request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Prefix ¶ added in v1.12.2

func (c *Client) Prefix(prefix string) *Client

Prefix is a chaining function, which sets the URL prefix for next request of this client.

func (*Client) Put ¶

func (c *Client) Put(url string, data ...interface{}) (*ClientResponse, error)

Put send PUT request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) PutBytes ¶

func (c *Client) PutBytes(url string, data ...interface{}) []byte

PutBytes sends a PUT request, retrieves and returns the result content as bytes.

func (*Client) PutContent ¶

func (c *Client) PutContent(url string, data ...interface{}) string

PutContent is a convenience method for sending PUT request, which retrieves and returns the result content and automatically closes response object.

func (*Client) RequestBytes ¶

func (c *Client) RequestBytes(method string, url string, data ...interface{}) []byte

RequestBytes sends request using given HTTP method and data, retrieves returns the result as bytes. It reads and closes the response object internally automatically.

func (*Client) RequestContent ¶

func (c *Client) RequestContent(method string, url string, data ...interface{}) string

RequestContent is a convenience method for sending custom http method request, which retrieves and returns the result content and automatically closes response object.

func (*Client) Retry ¶

func (c *Client) Retry(retryCount int, retryInterval time.Duration) *Client

Retry is a chaining function, which sets retry count and interval when failure for next request.

func (*Client) SetBasicAuth ¶

func (c *Client) SetBasicAuth(user, pass string) *Client

SetBasicAuth sets HTTP basic authentication information for the client.

func (*Client) SetBrowserMode ¶

func (c *Client) SetBrowserMode(enabled bool) *Client

SetBrowserMode enables browser mode of the client. When browser mode is enabled, it automatically saves and sends cookie content from and to server.

func (*Client) SetContentType ¶ added in v1.10.0

func (c *Client) SetContentType(contentType string) *Client

SetContentType sets HTTP content type for the client.

func (*Client) SetCookie ¶

func (c *Client) SetCookie(key, value string) *Client

SetCookie sets a cookie pair for the client.

func (*Client) SetCookieMap ¶

func (c *Client) SetCookieMap(m map[string]string) *Client

SetCookieMap sets cookie items with map.

func (*Client) SetCtx ¶ added in v1.12.0

func (c *Client) SetCtx(ctx context.Context) *Client

SetCtx sets context for each request of this client.

func (*Client) SetHeader ¶

func (c *Client) SetHeader(key, value string) *Client

SetHeader sets a custom HTTP header pair for the client.

func (*Client) SetHeaderMap ¶ added in v1.10.0

func (c *Client) SetHeaderMap(m map[string]string) *Client

SetHeaderMap sets custom HTTP headers with map.

func (*Client) SetHeaderRaw ¶

func (c *Client) SetHeaderRaw(headers string) *Client

SetHeaderRaw sets custom HTTP header using raw string.

func (*Client) SetPrefix ¶

func (c *Client) SetPrefix(prefix string) *Client

SetPrefix sets the request server URL prefix.

func (*Client) SetRetry ¶

func (c *Client) SetRetry(retryCount int, retryInterval time.Duration) *Client

SetRetry sets retry count and interval.

func (*Client) SetTimeout ¶ added in v1.12.0

func (c *Client) SetTimeout(t time.Duration) *Client

SetTimeOut sets the request timeout for the client.

func (*Client) Timeout ¶ added in v1.12.0

func (c *Client) Timeout(t time.Duration) *Client

TimeOut is a chaining function, which sets the timeout for next request.

func (*Client) Trace ¶

func (c *Client) Trace(url string, data ...interface{}) (*ClientResponse, error)

Trace send TRACE request and returns the response object. Note that the response object MUST be closed if it'll be never used.

func (*Client) TraceBytes ¶

func (c *Client) TraceBytes(url string, data ...interface{}) []byte

TraceBytes sends a TRACE request, retrieves and returns the result content as bytes.

func (*Client) TraceContent ¶

func (c *Client) TraceContent(url string, data ...interface{}) string

TraceContent is a convenience method for sending TRACE request, which retrieves and returns the result content and automatically closes response object.

func (*ClientResponse) Close ¶

func (r *ClientResponse) Close() error

Close closes the response when it will never be used.

func (*ClientResponse) GetCookie ¶

func (r *ClientResponse) GetCookie(key string) string

GetCookie retrieves and returns the cookie value of specified <key>.

func (*ClientResponse) GetCookieMap ¶ added in v1.12.0

func (r *ClientResponse) GetCookieMap() map[string]string

GetCookieMap retrieves and returns a copy of current cookie values map.

func (*ClientResponse) Raw ¶ added in v1.12.3

func (r *ClientResponse) Raw() string

Raw returns the raw text of the request and the response.

func (*ClientResponse) RawRequest ¶ added in v1.12.3

func (r *ClientResponse) RawRequest() string

RawRequest returns the raw content of the request.

func (*ClientResponse) RawResponse ¶ added in v1.12.3

func (r *ClientResponse) RawResponse() string

RawResponse returns the raw content of the response.

func (*ClientResponse) ReadAll ¶

func (r *ClientResponse) ReadAll() []byte

ReadAll retrieves and returns the response content as []byte.

func (*ClientResponse) ReadAllString ¶

func (r *ClientResponse) ReadAllString() string

ReadAllString retrieves and returns the response content as string.

func (*Cookie) Contains ¶

func (c *Cookie) Contains(key string) bool

Contains checks if given key exists and not expired in cookie.

func (*Cookie) Get ¶

func (c *Cookie) Get(key string, def ...string) string

Get retrieves and returns the value with specified key. It returns <def> if specified key does not exist and <def> is given.

func (*Cookie) GetSessionId ¶

func (c *Cookie) GetSessionId() string

GetSessionId retrieves and returns the session id from cookie.

func (*Cookie) Map ¶

func (c *Cookie) Map() map[string]string

Map returns the cookie items as map[string]string.

func (*Cookie) Output ¶

func (c *Cookie) Output()

Output outputs the cookie items to client.

func (*Cookie) Remove ¶

func (c *Cookie) Remove(key string)

Remove deletes specified key and its value from cookie using default domain and path. It actually tells the http client that the cookie is expired, do not send it to server next time.

func (*Cookie) RemoveCookie ¶

func (c *Cookie) RemoveCookie(key, domain, path string)

RemoveCookie deletes specified key and its value from cookie using given domain and path. It actually tells the http client that the cookie is expired, do not send it to server next time.

func (*Cookie) Set ¶

func (c *Cookie) Set(key, value string)

Set sets cookie item with default domain, path and expiration age.

func (*Cookie) SetCookie ¶

func (c *Cookie) SetCookie(key, value, domain, path string, maxAge time.Duration, httpOnly ...bool)

SetCookie sets cookie item given given domain, path and expiration age. The optional parameter <httpOnly> specifies if the cookie item is only available in HTTP, which is usually empty.

func (*Cookie) SetSessionId ¶

func (c *Cookie) SetSessionId(id string)

SetSessionId sets session id in the cookie.

func (*Domain) BindController ¶

func (d *Domain) BindController(pattern string, c Controller, methods ...string)

func (*Domain) BindControllerMethod ¶

func (d *Domain) BindControllerMethod(pattern string, c Controller, method string)

func (*Domain) BindControllerRest ¶

func (d *Domain) BindControllerRest(pattern string, c Controller)

func (*Domain) BindHandler ¶

func (d *Domain) BindHandler(pattern string, handler HandlerFunc)

func (*Domain) BindHookHandler ¶

func (d *Domain) BindHookHandler(pattern string, hook string, handler HandlerFunc)

func (*Domain) BindHookHandlerByMap ¶

func (d *Domain) BindHookHandlerByMap(pattern string, hookmap map[string]HandlerFunc)

func (*Domain) BindMiddleware ¶

func (d *Domain) BindMiddleware(pattern string, handlers ...HandlerFunc)

func (*Domain) BindMiddlewareDefault ¶ added in v1.10.0

func (d *Domain) BindMiddlewareDefault(handlers ...HandlerFunc)

func (*Domain) BindObject ¶

func (d *Domain) BindObject(pattern string, obj interface{}, methods ...string)

func (*Domain) BindObjectMethod ¶

func (d *Domain) BindObjectMethod(pattern string, obj interface{}, method string)

func (*Domain) BindObjectRest ¶

func (d *Domain) BindObjectRest(pattern string, obj interface{})

func (*Domain) BindStatusHandler ¶

func (d *Domain) BindStatusHandler(status int, handler HandlerFunc)

func (*Domain) BindStatusHandlerByMap ¶

func (d *Domain) BindStatusHandlerByMap(handlerMap map[int]HandlerFunc)

func (*Domain) Group ¶

func (d *Domain) Group(prefix string, groups ...func(group *RouterGroup)) *RouterGroup

Group creates and returns a RouterGroup object, which is bound to a specified domain.

func (*Domain) Use ¶ added in v1.11.5

func (d *Domain) Use(handlers ...HandlerFunc)

func (*Middleware) Next ¶

func (m *Middleware) Next()

Next calls the next workflow handler. It's an important function controlling the workflow of the server request execution.

func (*Request) Assign ¶ added in v1.10.0

func (r *Request) Assign(key string, value interface{})

Assign binds a template variable to current request.

func (*Request) Assigns ¶ added in v1.10.0

func (r *Request) Assigns(data gview.Params)

Assigns binds multiple template variables to current request.

func (*Request) BasicAuth ¶

func (r *Request) BasicAuth(user, pass string, tips ...string) bool

BasicAuth enables the http basic authentication feature with given passport and password and asks client for authentication. It returns true if authentication success, else returns false if failure.

func (*Request) Context ¶ added in v1.11.6

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

Context is alias for function GetCtx. This function overwrites the http.Request.Context function. See GetCtx.

func (*Request) Exit ¶

func (r *Request) Exit()

Exit exits executing of current HTTP handler.

func (*Request) ExitAll ¶

func (r *Request) ExitAll()

ExitAll exits executing of current and following HTTP handlers.

func (*Request) ExitHook ¶

func (r *Request) ExitHook()

ExitHook exits executing of current and following HTTP HOOK handlers.

func (*Request) Get ¶

func (r *Request) Get(key string, def ...interface{}) interface{}

Get is alias of GetRequest, which is one of the most commonly used functions for retrieving parameter. See r.GetRequest.

func (*Request) GetArray ¶

func (r *Request) GetArray(key string, def ...interface{}) []string

GetArray is an alias and convenient function for GetRequestArray. See GetRequestArray.

func (*Request) GetBody ¶ added in v1.10.0

func (r *Request) GetBody() []byte

GetBody retrieves and returns request body content as bytes. It can be called multiple times retrieving the same body content.

func (*Request) GetBodyString ¶ added in v1.10.0

func (r *Request) GetBodyString() string

GetBodyString retrieves and returns request body content as string. It can be called multiple times retrieving the same body content.

func (*Request) GetBool ¶ added in v1.9.2

func (r *Request) GetBool(key string, def ...interface{}) bool

GetBool is an alias and convenient function for GetRequestBool. See GetRequestBool.

func (*Request) GetClientIp ¶

func (r *Request) GetClientIp() string

GetClientIp returns the client ip of this request without port.

func (*Request) GetCtx ¶ added in v1.12.0

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

GetCtx retrieves and returns the request's context.

func (*Request) GetCtxVar ¶ added in v1.12.0

func (r *Request) GetCtxVar(key interface{}, def ...interface{}) *gvar.Var

GetCtxVar retrieves and returns a Var with given key name. The optional parameter <def> specifies the default value of the Var if given <key> does not exist in the context.

func (*Request) GetError ¶ added in v1.10.0

func (r *Request) GetError() error

GetError returns the error occurs in the procedure of the request. It returns nil if there's no error.

func (*Request) GetFloat32 ¶

func (r *Request) GetFloat32(key string, def ...interface{}) float32

GetFloat32 is an alias and convenient function for GetRequestFloat32. See GetRequestFloat32.

func (*Request) GetFloat64 ¶

func (r *Request) GetFloat64(key string, def ...interface{}) float64

GetFloat64 is an alias and convenient function for GetRequestFloat64. See GetRequestFloat64.

func (*Request) GetFloats ¶

func (r *Request) GetFloats(key string, def ...interface{}) []float64

GetFloats is an alias and convenient function for GetRequestFloats. See GetRequestFloats.

func (*Request) GetForm ¶ added in v1.10.0

func (r *Request) GetForm(key string, def ...interface{}) interface{}

GetForm retrieves and returns parameter <key> from form. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormArray ¶ added in v1.10.0

func (r *Request) GetFormArray(key string, def ...interface{}) []string

GetFormArray retrieves and returns parameter <key> from form as []string. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormBool ¶ added in v1.10.0

func (r *Request) GetFormBool(key string, def ...interface{}) bool

GetFormBool retrieves and returns parameter <key> from form as bool. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormFloat32 ¶ added in v1.10.0

func (r *Request) GetFormFloat32(key string, def ...interface{}) float32

GetFormFloat32 retrieves and returns parameter <key> from form as float32. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormFloat64 ¶ added in v1.10.0

func (r *Request) GetFormFloat64(key string, def ...interface{}) float64

GetFormFloat64 retrieves and returns parameter <key> from form as float64. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormFloats ¶ added in v1.10.0

func (r *Request) GetFormFloats(key string, def ...interface{}) []float64

GetFormFloats retrieves and returns parameter <key> from form as []float64. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormInt ¶ added in v1.10.0

func (r *Request) GetFormInt(key string, def ...interface{}) int

GetFormInt retrieves and returns parameter <key> from form as int. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormInt32 ¶ added in v1.10.0

func (r *Request) GetFormInt32(key string, def ...interface{}) int32

GetFormInt32 retrieves and returns parameter <key> from form as int32. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormInt64 ¶ added in v1.10.0

func (r *Request) GetFormInt64(key string, def ...interface{}) int64

GetFormInt64 retrieves and returns parameter <key> from form as int64. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormInterfaces ¶ added in v1.10.0

func (r *Request) GetFormInterfaces(key string, def ...interface{}) []interface{}

GetFormInterfaces retrieves and returns parameter <key> from form as []interface{}. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormInts ¶ added in v1.10.0

func (r *Request) GetFormInts(key string, def ...interface{}) []int

GetFormInts retrieves and returns parameter <key> from form as []int. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormMap ¶ added in v1.10.0

func (r *Request) GetFormMap(kvMap ...map[string]interface{}) map[string]interface{}

GetFormMap retrieves and returns all form parameters passed from client as map. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetFormMapStrStr ¶ added in v1.10.0

func (r *Request) GetFormMapStrStr(kvMap ...map[string]interface{}) map[string]string

GetFormMapStrStr retrieves and returns all form parameters passed from client as map[string]string. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetFormMapStrVar ¶ added in v1.10.0

func (r *Request) GetFormMapStrVar(kvMap ...map[string]interface{}) map[string]*gvar.Var

GetFormMapStrVar retrieves and returns all form parameters passed from client as map[string]*gvar.Var. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetFormString ¶ added in v1.10.0

func (r *Request) GetFormString(key string, def ...interface{}) string

GetFormString retrieves and returns parameter <key> from form as string. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormStrings ¶ added in v1.10.0

func (r *Request) GetFormStrings(key string, def ...interface{}) []string

GetFormStrings retrieves and returns parameter <key> from form as []string. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormStruct ¶ added in v1.10.1

func (r *Request) GetFormStruct(pointer interface{}, mapping ...map[string]string) error

GetFormStruct retrieves all form parameters passed from client and converts them to given struct object. Note that the parameter <pointer> is a pointer to the struct object. The optional parameter <mapping> is used to specify the key to attribute mapping.

func (*Request) GetFormToStruct ¶ added in v1.10.0

func (r *Request) GetFormToStruct(pointer interface{}, mapping ...map[string]string) error

GetFormToStruct is alias of GetFormStruct. See GetFormStruct. Deprecated.

func (*Request) GetFormUint ¶ added in v1.10.0

func (r *Request) GetFormUint(key string, def ...interface{}) uint

GetFormUint retrieves and returns parameter <key> from form as uint. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormUint32 ¶ added in v1.10.0

func (r *Request) GetFormUint32(key string, def ...interface{}) uint32

GetFormUint32 retrieves and returns parameter <key> from form as uint32. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormUint64 ¶ added in v1.10.0

func (r *Request) GetFormUint64(key string, def ...interface{}) uint64

GetFormUint64 retrieves and returns parameter <key> from form as uint64. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetFormVar ¶ added in v1.10.0

func (r *Request) GetFormVar(key string, def ...interface{}) *gvar.Var

GetFormVar retrieves and returns parameter <key> from form as Var. It returns <def> if <key> does not exist in the form and <def> is given, or else it returns nil.

func (*Request) GetHost ¶

func (r *Request) GetHost() string

GetHost returns current request host name, which might be a domain or an IP without port.

func (*Request) GetInt ¶

func (r *Request) GetInt(key string, def ...interface{}) int

GetInt is an alias and convenient function for GetRequestInt. See GetRequestInt.

func (*Request) GetInt32 ¶ added in v1.10.0

func (r *Request) GetInt32(key string, def ...interface{}) int32

GetInt32 is an alias and convenient function for GetRequestInt32. See GetRequestInt32.

func (*Request) GetInt64 ¶ added in v1.10.0

func (r *Request) GetInt64(key string, def ...interface{}) int64

GetInt64 is an alias and convenient function for GetRequestInt64. See GetRequestInt64.

func (*Request) GetInterfaces ¶

func (r *Request) GetInterfaces(key string, def ...interface{}) []interface{}

GetInterfaces is an alias and convenient function for GetRequestInterfaces. See GetRequestInterfaces.

func (*Request) GetInts ¶

func (r *Request) GetInts(key string, def ...interface{}) []int

GetInts is an alias and convenient function for GetRequestInts. See GetRequestInts.

func (*Request) GetJson ¶

func (r *Request) GetJson() (*gjson.Json, error)

GetJson parses current request content as JSON format, and returns the JSON object. Note that the request content is read from request BODY, not from any field of FORM.

func (*Request) GetMap ¶

func (r *Request) GetMap(def ...map[string]interface{}) map[string]interface{}

GetMap is an alias and convenient function for GetRequestMap. See GetRequestMap.

func (*Request) GetMapStrStr ¶ added in v1.9.3

func (r *Request) GetMapStrStr(def ...map[string]interface{}) map[string]string

GetMapStrStr is an alias and convenient function for GetRequestMapStrStr. See GetRequestMapStrStr.

func (*Request) GetMultipartFiles ¶ added in v1.10.0

func (r *Request) GetMultipartFiles(name string) []*multipart.FileHeader

GetMultipartFiles parses and returns the post files array. Note that the request form should be type of multipart.

func (*Request) GetMultipartForm ¶ added in v1.10.0

func (r *Request) GetMultipartForm() *multipart.Form

GetMultipartForm parses and returns the form as multipart form.

func (*Request) GetPage ¶ added in v1.11.6

func (r *Request) GetPage(totalSize, pageSize int) *gpage.Page

GetPage creates and returns the pagination object for given <totalSize> and <pageSize>. NOTE THAT the page parameter name from client is constantly defined as gpage.PAGE_NAME for simplification and convenience.

func (*Request) GetParam ¶

func (r *Request) GetParam(key string, def ...interface{}) interface{}

GetParam returns custom parameter with given name <key>. It returns <def> if <key> does not exist. It returns nil if <def> is not passed.

func (*Request) GetParamVar ¶ added in v1.9.2

func (r *Request) GetParamVar(key string, def ...interface{}) *gvar.Var

GetParamVar returns custom parameter with given name <key> as *gvar.Var. It returns <def> if <key> does not exist. It returns nil if <def> is not passed.

func (*Request) GetPost ¶

func (r *Request) GetPost(key string, def ...interface{}) interface{}

GetPost retrieves and returns parameter <key> from form and body. It returns <def> if <key> does not exist in neither form nor body. It returns nil if <def> is not passed.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: form > body.

Deprecated.

func (*Request) GetPostArray ¶

func (r *Request) GetPostArray(key string, def ...interface{}) []string

Deprecated.

func (*Request) GetPostBool ¶

func (r *Request) GetPostBool(key string, def ...interface{}) bool

Deprecated.

func (*Request) GetPostFloat32 ¶

func (r *Request) GetPostFloat32(key string, def ...interface{}) float32

Deprecated.

func (*Request) GetPostFloat64 ¶

func (r *Request) GetPostFloat64(key string, def ...interface{}) float64

Deprecated.

func (*Request) GetPostFloats ¶

func (r *Request) GetPostFloats(key string, def ...interface{}) []float64

Deprecated.

func (*Request) GetPostInt ¶

func (r *Request) GetPostInt(key string, def ...interface{}) int

Deprecated.

func (*Request) GetPostInt32 ¶ added in v1.9.8

func (r *Request) GetPostInt32(key string, def ...interface{}) int32

Deprecated.

func (*Request) GetPostInt64 ¶ added in v1.9.8

func (r *Request) GetPostInt64(key string, def ...interface{}) int64

Deprecated.

func (*Request) GetPostInterfaces ¶

func (r *Request) GetPostInterfaces(key string, def ...interface{}) []interface{}

Deprecated.

func (*Request) GetPostInts ¶

func (r *Request) GetPostInts(key string, def ...interface{}) []int

Deprecated.

func (*Request) GetPostMap ¶

func (r *Request) GetPostMap(kvMap ...map[string]interface{}) map[string]interface{}

GetPostMap retrieves and returns all parameters in the form and body passed from client as map. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: form > body.

Deprecated.

func (*Request) GetPostMapStrStr ¶ added in v1.9.3

func (r *Request) GetPostMapStrStr(kvMap ...map[string]interface{}) map[string]string

GetPostMapStrStr retrieves and returns all parameters in the form and body passed from client as map[string]string. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

Deprecated.

func (*Request) GetPostMapStrVar ¶ added in v1.9.3

func (r *Request) GetPostMapStrVar(kvMap ...map[string]interface{}) map[string]*gvar.Var

GetPostMapStrVar retrieves and returns all parameters in the form and body passed from client as map[string]*gvar.Var. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

Deprecated.

func (*Request) GetPostString ¶

func (r *Request) GetPostString(key string, def ...interface{}) string

Deprecated.

func (*Request) GetPostStrings ¶

func (r *Request) GetPostStrings(key string, def ...interface{}) []string

Deprecated.

func (*Request) GetPostStruct ¶ added in v1.10.1

func (r *Request) GetPostStruct(pointer interface{}, mapping ...map[string]string) error

GetPostStruct retrieves all parameters in the form and body passed from client and converts them to given struct object. Note that the parameter <pointer> is a pointer to the struct object. The optional parameter <mapping> is used to specify the key to attribute mapping.

Deprecated.

func (*Request) GetPostToStruct ¶

func (r *Request) GetPostToStruct(pointer interface{}, mapping ...map[string]string) error

GetPostToStruct is alias of GetQueryStruct. See GetPostStruct.

Deprecated.

func (*Request) GetPostUint ¶

func (r *Request) GetPostUint(key string, def ...interface{}) uint

Deprecated.

func (*Request) GetPostUint32 ¶ added in v1.9.8

func (r *Request) GetPostUint32(key string, def ...interface{}) uint32

Deprecated.

func (*Request) GetPostUint64 ¶ added in v1.9.8

func (r *Request) GetPostUint64(key string, def ...interface{}) uint64

Deprecated.

func (*Request) GetPostVar ¶

func (r *Request) GetPostVar(key string, def ...interface{}) *gvar.Var

Deprecated.

func (*Request) GetQuery ¶

func (r *Request) GetQuery(key string, def ...interface{}) interface{}

GetQuery retrieves and returns parameter with given name <key> from query string and request body. It returns <def> if <key> does not exist in the query and <def> is given, or else it returns nil.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: query > body.

func (*Request) GetQueryArray ¶

func (r *Request) GetQueryArray(key string, def ...interface{}) []string

func (*Request) GetQueryBool ¶

func (r *Request) GetQueryBool(key string, def ...interface{}) bool

func (*Request) GetQueryFloat32 ¶

func (r *Request) GetQueryFloat32(key string, def ...interface{}) float32

func (*Request) GetQueryFloat64 ¶

func (r *Request) GetQueryFloat64(key string, def ...interface{}) float64

func (*Request) GetQueryFloats ¶

func (r *Request) GetQueryFloats(key string, def ...interface{}) []float64

func (*Request) GetQueryInt ¶

func (r *Request) GetQueryInt(key string, def ...interface{}) int

func (*Request) GetQueryInt32 ¶ added in v1.9.8

func (r *Request) GetQueryInt32(key string, def ...interface{}) int32

func (*Request) GetQueryInt64 ¶ added in v1.9.8

func (r *Request) GetQueryInt64(key string, def ...interface{}) int64

func (*Request) GetQueryInterfaces ¶

func (r *Request) GetQueryInterfaces(key string, def ...interface{}) []interface{}

func (*Request) GetQueryInts ¶

func (r *Request) GetQueryInts(key string, def ...interface{}) []int

func (*Request) GetQueryMap ¶

func (r *Request) GetQueryMap(kvMap ...map[string]interface{}) map[string]interface{}

GetQueryMap retrieves and returns all parameters passed from client using HTTP GET method as map. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: query > body.

func (*Request) GetQueryMapStrStr ¶ added in v1.9.3

func (r *Request) GetQueryMapStrStr(kvMap ...map[string]interface{}) map[string]string

GetQueryMapStrStr retrieves and returns all parameters passed from client using HTTP GET method as map[string]string. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetQueryMapStrVar ¶ added in v1.9.3

func (r *Request) GetQueryMapStrVar(kvMap ...map[string]interface{}) map[string]*gvar.Var

GetQueryMapStrVar retrieves and returns all parameters passed from client using HTTP GET method as map[string]*gvar.Var. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetQueryString ¶

func (r *Request) GetQueryString(key string, def ...interface{}) string

func (*Request) GetQueryStrings ¶

func (r *Request) GetQueryStrings(key string, def ...interface{}) []string

func (*Request) GetQueryStruct ¶ added in v1.10.1

func (r *Request) GetQueryStruct(pointer interface{}, mapping ...map[string]string) error

GetQueryStruct retrieves all parameters passed from client using HTTP GET method and converts them to given struct object. Note that the parameter <pointer> is a pointer to the struct object. The optional parameter <mapping> is used to specify the key to attribute mapping.

func (*Request) GetQueryToStruct ¶

func (r *Request) GetQueryToStruct(pointer interface{}, mapping ...map[string]string) error

GetQueryToStruct is alias of GetQueryStruct. See GetQueryStruct. Deprecated.

func (*Request) GetQueryUint ¶

func (r *Request) GetQueryUint(key string, def ...interface{}) uint

func (*Request) GetQueryUint32 ¶ added in v1.9.8

func (r *Request) GetQueryUint32(key string, def ...interface{}) uint32

func (*Request) GetQueryUint64 ¶ added in v1.9.8

func (r *Request) GetQueryUint64(key string, def ...interface{}) uint64

func (*Request) GetQueryVar ¶

func (r *Request) GetQueryVar(key string, def ...interface{}) *gvar.Var

func (*Request) GetRaw ¶

func (r *Request) GetRaw() []byte

GetRaw is alias of GetBody. See GetBody. Deprecated.

func (*Request) GetRawString ¶

func (r *Request) GetRawString() string

GetRawString is alias of GetBodyString. See GetBodyString. Deprecated.

func (*Request) GetReferer ¶

func (r *Request) GetReferer() string

GetReferer returns referer of this request.

func (*Request) GetRequest ¶

func (r *Request) GetRequest(key string, def ...interface{}) interface{}

GetRequest retrieves and returns the parameter named <key> passed from client and custom params as interface{}, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

GetRequest is one of the most commonly used functions for retrieving parameters.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: router < query < body < form < custom.

func (*Request) GetRequestArray ¶

func (r *Request) GetRequestArray(key string, def ...interface{}) []string

GetRequestArray retrieves and returns the parameter named <key> passed from client and custom params as []string, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestBool ¶

func (r *Request) GetRequestBool(key string, def ...interface{}) bool

GetRequestBool retrieves and returns the parameter named <key> passed from client and custom params as bool, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestFloat32 ¶

func (r *Request) GetRequestFloat32(key string, def ...interface{}) float32

GetRequestFloat32 retrieves and returns the parameter named <key> passed from client and custom params as float32, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestFloat64 ¶

func (r *Request) GetRequestFloat64(key string, def ...interface{}) float64

GetRequestFloat64 retrieves and returns the parameter named <key> passed from client and custom params as float64, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestFloats ¶

func (r *Request) GetRequestFloats(key string, def ...interface{}) []float64

GetRequestFloats retrieves and returns the parameter named <key> passed from client and custom params as []float64, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestInt ¶

func (r *Request) GetRequestInt(key string, def ...interface{}) int

GetRequestInt retrieves and returns the parameter named <key> passed from client and custom params as int, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestInt32 ¶ added in v1.9.8

func (r *Request) GetRequestInt32(key string, def ...interface{}) int32

GetRequestInt32 retrieves and returns the parameter named <key> passed from client and custom params as int32, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestInt64 ¶ added in v1.9.8

func (r *Request) GetRequestInt64(key string, def ...interface{}) int64

GetRequestInt64 retrieves and returns the parameter named <key> passed from client and custom params as int64, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestInterfaces ¶

func (r *Request) GetRequestInterfaces(key string, def ...interface{}) []interface{}

GetRequestInterfaces retrieves and returns the parameter named <key> passed from client and custom params as []interface{}, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestInts ¶

func (r *Request) GetRequestInts(key string, def ...interface{}) []int

GetRequestInts retrieves and returns the parameter named <key> passed from client and custom params as []int, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestMap ¶

func (r *Request) GetRequestMap(kvMap ...map[string]interface{}) map[string]interface{}

GetRequestMap retrieves and returns all parameters passed from client and custom params as map, no matter what HTTP method the client is using. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass the according keys.

GetRequestMap is one of the most commonly used functions for retrieving parameters.

Note that if there're multiple parameters with the same name, the parameters are retrieved and overwrote in order of priority: router < query < body < form < custom.

func (*Request) GetRequestMapStrStr ¶ added in v1.9.3

func (r *Request) GetRequestMapStrStr(kvMap ...map[string]interface{}) map[string]string

GetRequestMapStrStr retrieves and returns all parameters passed from client and custom params as map[string]string, no matter what HTTP method the client is using. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetRequestMapStrVar ¶ added in v1.9.3

func (r *Request) GetRequestMapStrVar(kvMap ...map[string]interface{}) map[string]*gvar.Var

GetRequestMapStrVar retrieves and returns all parameters passed from client and custom params as map[string]*gvar.Var, no matter what HTTP method the client is using. The parameter <kvMap> specifies the keys retrieving from client parameters, the associated values are the default values if the client does not pass.

func (*Request) GetRequestString ¶

func (r *Request) GetRequestString(key string, def ...interface{}) string

GetRequestString retrieves and returns the parameter named <key> passed from client and custom params as string, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestStrings ¶

func (r *Request) GetRequestStrings(key string, def ...interface{}) []string

GetRequestStrings retrieves and returns the parameter named <key> passed from client and custom params as []string, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestStruct ¶ added in v1.10.1

func (r *Request) GetRequestStruct(pointer interface{}, mapping ...map[string]string) error

GetRequestStruct retrieves all parameters passed from client and custom params no matter what HTTP method the client is using, and converts them to given struct object. Note that the parameter <pointer> is a pointer to the struct object. The optional parameter <mapping> is used to specify the key to attribute mapping.

func (*Request) GetRequestToStruct ¶

func (r *Request) GetRequestToStruct(pointer interface{}, mapping ...map[string]string) error

GetRequestToStruct is alias of GetRequestStruct. See GetRequestStruct. Deprecated.

func (*Request) GetRequestUint ¶

func (r *Request) GetRequestUint(key string, def ...interface{}) uint

GetRequestUint retrieves and returns the parameter named <key> passed from client and custom params as uint, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestUint32 ¶ added in v1.9.8

func (r *Request) GetRequestUint32(key string, def ...interface{}) uint32

GetRequestUint32 retrieves and returns the parameter named <key> passed from client and custom params as uint32, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestUint64 ¶ added in v1.9.8

func (r *Request) GetRequestUint64(key string, def ...interface{}) uint64

GetRequestUint64 retrieves and returns the parameter named <key> passed from client and custom params as uint64, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRequestVar ¶

func (r *Request) GetRequestVar(key string, def ...interface{}) *gvar.Var

GetRequestVar retrieves and returns the parameter named <key> passed from client and custom params as *gvar.Var, no matter what HTTP method the client is using. The parameter <def> specifies the default value if the <key> does not exist.

func (*Request) GetRouterString ¶

func (r *Request) GetRouterString(key string, def ...interface{}) string

GetRouterString retrieves and returns the router value as string with given key name <key>. It returns <def> if <key> does not exist.

func (*Request) GetRouterValue ¶ added in v1.9.2

func (r *Request) GetRouterValue(key string, def ...interface{}) interface{}

GetRouterValue retrieves and returns the router value with given key name <key>. It returns <def> if <key> does not exist.

func (*Request) GetRouterVar ¶ added in v1.9.2

func (r *Request) GetRouterVar(key string, def ...interface{}) *gvar.Var

GetRouterVar retrieves and returns the router value as *gvar.var with given key name <key>. It returns <def> if <key> does not exist.

func (*Request) GetSessionId ¶

func (r *Request) GetSessionId() string

GetSessionId retrieves and returns session id from cookie or header.

func (*Request) GetString ¶

func (r *Request) GetString(key string, def ...interface{}) string

GetString is an alias and convenient function for GetRequestString. See GetRequestString.

func (*Request) GetStrings ¶

func (r *Request) GetStrings(key string, def ...interface{}) []string

GetStrings is an alias and convenient function for GetRequestStrings. See GetRequestStrings.

func (*Request) GetStruct ¶ added in v1.10.1

func (r *Request) GetStruct(pointer interface{}, mapping ...map[string]string) error

GetStruct is an alias and convenient function for GetRequestStruct. See GetRequestStruct.

func (*Request) GetToStruct ¶

func (r *Request) GetToStruct(pointer interface{}, mapping ...map[string]string) error

GetToStruct is an alias and convenient function for GetRequestStruct. See GetRequestToStruct. Deprecated.

func (*Request) GetUint ¶

func (r *Request) GetUint(key string, def ...interface{}) uint

GetUint is an alias and convenient function for GetRequestUint. See GetRequestUint.

func (*Request) GetUint32 ¶ added in v1.10.0

func (r *Request) GetUint32(key string, def ...interface{}) uint32

GetUint32 is an alias and convenient function for GetRequestUint32. See GetRequestUint32.

func (*Request) GetUint64 ¶ added in v1.10.0

func (r *Request) GetUint64(key string, def ...interface{}) uint64

GetUint64 is an alias and convenient function for GetRequestUint64. See GetRequestUint64.

func (*Request) GetUploadFile ¶ added in v1.11.5

func (r *Request) GetUploadFile(name string) *UploadFile

GetUploadFile retrieves and returns the uploading file with specified form name. This function is used for retrieving single uploading file object, which is uploaded using multipart form content type.

It returns nil if retrieving failed or no form file with given name posted.

Note that the <name> is the file field name of the multipart form from client.

func (*Request) GetUploadFiles ¶ added in v1.11.5

func (r *Request) GetUploadFiles(name string) UploadFiles

GetUploadFiles retrieves and returns multiple uploading files with specified form name. This function is used for retrieving multiple uploading file objects, which are uploaded using multipart form content type.

It returns nil if retrieving failed or no form file with given name posted.

Note that the <name> is the file field name of the multipart form from client.

func (*Request) GetUrl ¶

func (r *Request) GetUrl() string

GetUrl returns current URL of this request.

func (*Request) GetVar ¶

func (r *Request) GetVar(key string, def ...interface{}) *gvar.Var

GetVar is alis of GetRequestVar. See GetRequestVar.

func (*Request) GetView ¶ added in v1.10.0

func (r *Request) GetView() *gview.View

GetView returns the template view engine object for this request.

func (*Request) IsAjaxRequest ¶

func (r *Request) IsAjaxRequest() bool

IsAjaxRequest checks and returns whether current request is an AJAX request.

func (*Request) IsExited ¶

func (r *Request) IsExited() bool

IsExited checks and returns whether current request is exited.

func (*Request) IsFileRequest ¶

func (r *Request) IsFileRequest() bool

IsFileRequest checks and returns whether current request is serving file.

func (*Request) Parse ¶ added in v1.11.0

func (r *Request) Parse(pointer interface{}) error

Parse is the most commonly used function, which converts request parameters to struct or struct slice. It also automatically validates the struct or every element of the struct slice according to the validation tag of the struct.

The parameter <pointer> can be type of: *struct/**struct/*[]struct/*[]*struct.

It supports single and multiple struct convertion: 1. Single struct, post content like: {"id":1, "name":"john"} 2. Multiple struct, post content like: [{"id":1, "name":"john"}, {"id":, "name":"smith"}]

TODO: Improve the performance by reducing duplicated reflect usage on the same variable across packages.

func (*Request) RefillBody ¶ added in v1.11.5

func (r *Request) RefillBody()

RefillBody refills the request body object after read all of its content. It makes the request body reusable for next reading.

func (*Request) SetCtxVar ¶ added in v1.12.0

func (r *Request) SetCtxVar(key interface{}, value interface{})

SetCtxVar sets custom parameter to context with key-value pair.

func (*Request) SetForm ¶ added in v1.10.0

func (r *Request) SetForm(key string, value interface{})

SetForm sets custom form value with key-value pair.

func (*Request) SetParam ¶

func (r *Request) SetParam(key string, value interface{})

SetParam sets custom parameter with key-value pair.

func (*Request) SetQuery ¶

func (r *Request) SetQuery(key string, value interface{})

SetQuery sets custom query value with key-value pair.

func (*Request) SetView ¶ added in v1.10.0

func (r *Request) SetView(view *gview.View)

SetView sets template view engine object for this request.

func (*Request) WebSocket ¶

func (r *Request) WebSocket() (*WebSocket, error)

WebSocket upgrades current request as a websocket request. It returns a new WebSocket object if success, or the error if failure. Note that the request should be a websocket request, or it will surely fail upgrading.

func (*Response) Buffer ¶

func (r *Response) Buffer() []byte

BufferString returns the buffered content as []byte.

func (*Response) BufferLength ¶

func (r *Response) BufferLength() int

BufferLength returns the length of the buffered content.

func (*Response) BufferString ¶ added in v1.9.3

func (r *Response) BufferString() string

BufferString returns the buffered content as string.

func (*Response) CORS ¶

func (r *Response) CORS(options CORSOptions)

CORS sets custom CORS options. See https://www.w3.org/TR/cors/ .

func (*Response) CORSAllowedOrigin ¶ added in v1.9.3

func (r *Response) CORSAllowedOrigin(options CORSOptions) bool

CORSAllowed checks whether the current request origin is allowed cross-domain.

func (*Response) CORSDefault ¶

func (r *Response) CORSDefault()

CORSDefault sets CORS with default CORS options, which allows any cross-domain request.

func (*Response) ClearBuffer ¶

func (r *Response) ClearBuffer()

ClearBuffer clears the response buffer.

func (*Response) DefaultCORSOptions ¶

func (r *Response) DefaultCORSOptions() CORSOptions

DefaultCORSOptions returns the default CORS options, which allows any cross-domain request.

func (*Response) Output ¶

func (r *Response) Output()

Output outputs the buffer content to the client and clears the buffer.

func (*Response) ParseTpl ¶

func (r *Response) ParseTpl(tpl string, params ...gview.Params) (string, error)

ParseTpl parses given template file <tpl> with given template variables <params> and returns the parsed template content.

func (*Response) ParseTplContent ¶

func (r *Response) ParseTplContent(content string, params ...gview.Params) (string, error)

ParseTplContent parses given template file <file> with given template parameters <params> and returns the parsed template content.

func (*Response) ParseTplDefault ¶ added in v1.10.0

func (r *Response) ParseTplDefault(params ...gview.Params) (string, error)

ParseDefault parses the default template file with params.

func (*Response) RedirectBack ¶

func (r *Response) RedirectBack(code ...int)

RedirectBack redirects client back to referer. The optional parameter <code> specifies the http status code for redirecting, which commonly can be 301 or 302. It's 302 in default.

func (*Response) RedirectTo ¶

func (r *Response) RedirectTo(location string, code ...int)

RedirectTo redirects client to another location. The optional parameter <code> specifies the http status code for redirecting, which commonly can be 301 or 302. It's 302 in default.

func (*Response) ServeFile ¶

func (r *Response) ServeFile(path string, allowIndex ...bool)

ServeFile serves the file to the response.

func (*Response) ServeFileDownload ¶

func (r *Response) ServeFileDownload(path string, name ...string)

ServeFileDownload serves file downloading to the response.

func (*Response) SetBuffer ¶

func (r *Response) SetBuffer(data []byte)

SetBuffer overwrites the buffer with <data>.

func (*Response) Write ¶

func (r *Response) Write(content ...interface{})

Write writes <content> to the response buffer.

func (*Response) WriteExit ¶ added in v1.10.0

func (r *Response) WriteExit(content ...interface{})

WriteExit writes <content> to the response buffer and exits executing of current handler. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) WriteJson ¶

func (r *Response) WriteJson(content interface{}) error

WriteJson writes <content> to the response with JSON format.

func (*Response) WriteJsonExit ¶ added in v1.10.0

func (r *Response) WriteJsonExit(content interface{}) error

WriteJsonExit writes <content> to the response with JSON format and exits executing of current handler if success. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) WriteJsonP ¶

func (r *Response) WriteJsonP(content interface{}) error

WriteJson writes <content> to the response with JSONP format.

Note that there should be a "callback" parameter in the request for JSONP format.

func (*Response) WriteJsonPExit ¶ added in v1.10.0

func (r *Response) WriteJsonPExit(content interface{}) error

WriteJsonPExit writes <content> to the response with JSONP format and exits executing of current handler if success. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

Note that there should be a "callback" parameter in the request for JSONP format.

func (*Response) WriteOver ¶ added in v1.9.8

func (r *Response) WriteOver(content ...interface{})

WriteOver overwrites the response buffer with <content>.

func (*Response) WriteOverExit ¶ added in v1.10.0

func (r *Response) WriteOverExit(content ...interface{})

WriteOverExit overwrites the response buffer with <content> and exits executing of current handler. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) WriteStatus ¶

func (r *Response) WriteStatus(status int, content ...interface{})

WriteStatus writes HTTP <status> and <content> to the response. Note that do not set Content-Type header here.

func (*Response) WriteStatusExit ¶ added in v1.10.0

func (r *Response) WriteStatusExit(status int, content ...interface{})

WriteStatusExit writes HTTP <status> and <content> to the response and exits executing of current handler if success. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) WriteTpl ¶

func (r *Response) WriteTpl(tpl string, params ...gview.Params) error

WriteTpl parses and responses given template file. The parameter <params> specifies the template variables for parsing.

func (*Response) WriteTplContent ¶

func (r *Response) WriteTplContent(content string, params ...gview.Params) error

WriteTplContent parses and responses the template content. The parameter <params> specifies the template variables for parsing.

func (*Response) WriteTplDefault ¶ added in v1.10.0

func (r *Response) WriteTplDefault(params ...gview.Params) error

WriteTplDefault parses and responses the default template file. The parameter <params> specifies the template variables for parsing.

func (*Response) WriteXml ¶

func (r *Response) WriteXml(content interface{}, rootTag ...string) error

WriteXml writes <content> to the response with XML format.

func (*Response) WriteXmlExit ¶ added in v1.10.0

func (r *Response) WriteXmlExit(content interface{}, rootTag ...string) error

WriteXmlExit writes <content> to the response with XML format and exits executing of current handler if success. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) Writef ¶

func (r *Response) Writef(format string, params ...interface{})

Writef writes the response with fmt.Sprintf.

func (*Response) WritefExit ¶ added in v1.10.0

func (r *Response) WritefExit(format string, params ...interface{})

WritefExit writes the response with fmt.Sprintf and exits executing of current handler. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) Writefln ¶

func (r *Response) Writefln(format string, params ...interface{})

Writefln writes the response with fmt.Sprintf and new line.

func (*Response) WriteflnExit ¶ added in v1.10.0

func (r *Response) WriteflnExit(format string, params ...interface{})

WriteflnExit writes the response with fmt.Sprintf and new line and exits executing of current handler. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*Response) Writeln ¶

func (r *Response) Writeln(content ...interface{})

Writef writes the response with <content> and new line.

func (*Response) WritelnExit ¶ added in v1.10.0

func (r *Response) WritelnExit(content ...interface{})

WritelnExit writes the response with <content> and new line and exits executing of current handler. The "Exit" feature is commonly used to replace usage of return statement in the handler, for convenience.

func (*ResponseWriter) Header ¶ added in v1.9.4

func (w *ResponseWriter) Header() http.Header

Header implements the interface function of http.ResponseWriter.Header.

func (*ResponseWriter) Hijack ¶ added in v1.9.4

func (w *ResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

Hijack implements the interface function of http.Hijacker.Hijack.

func (*ResponseWriter) OutputBuffer ¶

func (w *ResponseWriter) OutputBuffer()

OutputBuffer outputs the buffer to client and clears the buffer.

func (*ResponseWriter) RawWriter ¶ added in v1.9.8

func (w *ResponseWriter) RawWriter() http.ResponseWriter

RawWriter returns the underlying ResponseWriter.

func (*ResponseWriter) Write ¶

func (w *ResponseWriter) Write(data []byte) (int, error)

Write implements the interface function of http.ResponseWriter.Write.

func (*ResponseWriter) WriteHeader ¶

func (w *ResponseWriter) WriteHeader(status int)

WriteHeader implements the interface of http.ResponseWriter.WriteHeader.

func (*RouterGroup) ALL ¶

func (g *RouterGroup) ALL(pattern string, object interface{}, params ...interface{}) *RouterGroup

ALL registers a http handler to given route pattern and all http methods.

func (*RouterGroup) Bind ¶

func (g *RouterGroup) Bind(items []GroupItem) *RouterGroup

Bind does batch route registering feature for router group.

func (*RouterGroup) CONNECT ¶

func (g *RouterGroup) CONNECT(pattern string, object interface{}, params ...interface{}) *RouterGroup

CONNECT registers a http handler to given route pattern and http method: CONNECT.

func (*RouterGroup) Clone ¶

func (g *RouterGroup) Clone() *RouterGroup

Clone returns a new router group which is a clone of current group.

func (*RouterGroup) DELETE ¶

func (g *RouterGroup) DELETE(pattern string, object interface{}, params ...interface{}) *RouterGroup

DELETE registers a http handler to given route pattern and http method: DELETE.

func (*RouterGroup) GET ¶

func (g *RouterGroup) GET(pattern string, object interface{}, params ...interface{}) *RouterGroup

GET registers a http handler to given route pattern and http method: GET.

func (*RouterGroup) Group ¶

func (g *RouterGroup) Group(prefix string, groups ...func(group *RouterGroup)) *RouterGroup

Group creates and returns a sub-group of current router group.

func (*RouterGroup) HEAD ¶

func (g *RouterGroup) HEAD(pattern string, object interface{}, params ...interface{}) *RouterGroup

HEAD registers a http handler to given route pattern and http method: HEAD.

func (*RouterGroup) Hook ¶

func (g *RouterGroup) Hook(pattern string, hook string, handler HandlerFunc) *RouterGroup

Hook registers a hook to given route pattern.

func (*RouterGroup) Middleware ¶

func (g *RouterGroup) Middleware(handlers ...HandlerFunc) *RouterGroup

Middleware binds one or more middleware to the router group.

func (*RouterGroup) OPTIONS ¶

func (g *RouterGroup) OPTIONS(pattern string, object interface{}, params ...interface{}) *RouterGroup

OPTIONS registers a http handler to given route pattern and http method: OPTIONS.

func (*RouterGroup) PATCH ¶

func (g *RouterGroup) PATCH(pattern string, object interface{}, params ...interface{}) *RouterGroup

PATCH registers a http handler to given route pattern and http method: PATCH.

func (*RouterGroup) POST ¶

func (g *RouterGroup) POST(pattern string, object interface{}, params ...interface{}) *RouterGroup

POST registers a http handler to given route pattern and http method: POST.

func (*RouterGroup) PUT ¶

func (g *RouterGroup) PUT(pattern string, object interface{}, params ...interface{}) *RouterGroup

PUT registers a http handler to given route pattern and http method: PUT.

func (*RouterGroup) REST ¶

func (g *RouterGroup) REST(pattern string, object interface{}) *RouterGroup

REST registers a http handler to given route pattern according to REST rule.

func (*RouterGroup) TRACE ¶

func (g *RouterGroup) TRACE(pattern string, object interface{}, params ...interface{}) *RouterGroup

TRACE registers a http handler to given route pattern and http method: TRACE.

func (*Server) AddSearchPath ¶

func (s *Server) AddSearchPath(path string)

AddSearchPath add searching directory path for static file service.

func (*Server) AddStaticPath ¶

func (s *Server) AddStaticPath(prefix string, path string)

AddStaticPath sets the uri to static directory path mapping for static file service.

func (*Server) BindController ¶

func (s *Server) BindController(pattern string, controller Controller, method ...string)

BindController registers controller to server routes with specified pattern. The controller needs to implement the gmvc.Controller interface. Each request of the controller bound in this way will initialize a new controller object for processing, corresponding to different request sessions.

The optional parameter <method> is used to specify the method to be registered, which supports multiple method names, multiple methods are separated by char ',', case sensitive.

func (*Server) BindControllerMethod ¶

func (s *Server) BindControllerMethod(pattern string, controller Controller, method string)

BindControllerMethod registers specified method to server routes with specified pattern.

The optional parameter <method> is used to specify the method to be registered, which does not supports multiple method names but only one, case sensitive.

func (*Server) BindControllerRest ¶

func (s *Server) BindControllerRest(pattern string, controller Controller)

BindControllerRest registers controller in REST API style to server with specified pattern. The controller needs to implement the gmvc.Controller interface. Each request of the controller bound in this way will initialize a new controller object for processing, corresponding to different request sessions. The method will recognize the HTTP method and do REST binding, for example: The method "Post" of controller will be bound to the HTTP POST method request processing, and the method "Delete" will be bound to the HTTP DELETE method request processing. Therefore, only the method corresponding to the HTTP Method will be bound, other methods will not automatically register the binding.

func (*Server) BindHandler ¶

func (s *Server) BindHandler(pattern string, handler HandlerFunc)

BindHandler registers a handler function to server with given pattern.

func (*Server) BindHookHandler ¶

func (s *Server) BindHookHandler(pattern string, hook string, handler HandlerFunc)

BindHookHandler registers handler for specified hook.

func (*Server) BindHookHandlerByMap ¶

func (s *Server) BindHookHandlerByMap(pattern string, hookMap map[string]HandlerFunc)

func (*Server) BindMiddleware ¶

func (s *Server) BindMiddleware(pattern string, handlers ...HandlerFunc)

BindMiddleware registers one or more global middleware to the server. Global middleware can be used standalone without service handler, which intercepts all dynamic requests before or after service handler. The parameter <pattern> specifies what route pattern the middleware intercepts, which is usually a "fuzzy" pattern like "/:name", "/*any" or "/{field}".

func (*Server) BindMiddlewareDefault ¶ added in v1.9.2

func (s *Server) BindMiddlewareDefault(handlers ...HandlerFunc)

BindMiddlewareDefault registers one or more global middleware to the server using default pattern "/*". Global middleware can be used standalone without service handler, which intercepts all dynamic requests before or after service handler.

func (*Server) BindObject ¶

func (s *Server) BindObject(pattern string, object interface{}, method ...string)

BindObject registers object to server routes with given pattern.

The optional parameter <method> is used to specify the method to be registered, which supports multiple method names, multiple methods are separated by char ',', case sensitive.

Note that the route method should be defined as ghttp.HandlerFunc.

func (*Server) BindObjectMethod ¶

func (s *Server) BindObjectMethod(pattern string, object interface{}, method string)

BindObjectMethod registers specified method of object to server routes with given pattern.

The optional parameter <method> is used to specify the method to be registered, which does not supports multiple method names but only one, case sensitive.

Note that the route method should be defined as ghttp.HandlerFunc.

func (*Server) BindObjectRest ¶

func (s *Server) BindObjectRest(pattern string, object interface{})

BindObjectRest registers object in REST API style to server with specified pattern. Note that the route method should be defined as ghttp.HandlerFunc.

func (*Server) BindStatusHandler ¶

func (s *Server) BindStatusHandler(status int, handler HandlerFunc)

BindStatusHandler registers handler for given status code.

func (*Server) BindStatusHandlerByMap ¶

func (s *Server) BindStatusHandlerByMap(handlerMap map[int]HandlerFunc)

BindStatusHandlerByMap registers handler for given status code using map.

func (*Server) Domain ¶

func (s *Server) Domain(domains string) *Domain

Domain creates and returns a domain object for management for one or more domains.

func (*Server) EnableAdmin ¶

func (s *Server) EnableAdmin(pattern ...string)

EnableAdmin enables the administration feature for the process. The optional parameter <pattern> specifies the URI for the administration page.

func (*Server) EnableHTTPS ¶

func (s *Server) EnableHTTPS(certFile, keyFile string, tlsConfig ...*tls.Config)

EnableHTTPS enables HTTPS with given certification and key files for the server. The optional parameter <tlsConfig> specifies custom TLS configuration.

func (*Server) EnablePProf ¶ added in v1.10.0

func (s *Server) EnablePProf(pattern ...string)

EnablePProf enables PProf feature for server.

func (*Server) GetCookieDomain ¶

func (s *Server) GetCookieDomain() string

GetCookieDomain returns CookieDomain of server.

func (*Server) GetCookieMaxAge ¶

func (s *Server) GetCookieMaxAge() time.Duration

GetCookieMaxAge returns the CookieMaxAge of server.

func (*Server) GetCookiePath ¶

func (s *Server) GetCookiePath() string

GetCookiePath returns the CookiePath of server.

func (*Server) GetIndexFiles ¶ added in v1.11.3

func (s *Server) GetIndexFiles() []string

GetIndexFiles retrieves and returns the index files from server.

func (*Server) GetLogPath ¶

func (s *Server) GetLogPath() string

GetLogPath returns the log path.

func (*Server) GetName ¶

func (s *Server) GetName() string

GetName returns the name of the server.

func (*Server) GetRouterArray ¶ added in v1.10.1

func (s *Server) GetRouterArray() []RouterItem

GetRouterArray retrieves and returns the router array. The key of the returned map is the domain of the server.

func (*Server) GetSessionIdName ¶

func (s *Server) GetSessionIdName() string

GetSessionIdName returns the SessionIdName of server.

func (*Server) GetSessionMaxAge ¶

func (s *Server) GetSessionMaxAge() time.Duration

GetSessionMaxAge returns the SessionMaxAge of server.

func (*Server) Group ¶

func (s *Server) Group(prefix string, groups ...func(group *RouterGroup)) *RouterGroup

Group creates and returns a RouterGroup object.

func (*Server) Handler ¶ added in v1.10.0

func (s *Server) Handler() http.Handler

Handler returns the request handler of the server.

func (*Server) IsAccessLogEnabled ¶

func (s *Server) IsAccessLogEnabled() bool

IsAccessLogEnabled checks whether the access log enabled.

func (*Server) IsErrorLogEnabled ¶

func (s *Server) IsErrorLogEnabled() bool

IsErrorLogEnabled checks whether the error log enabled.

func (*Server) Logger ¶ added in v1.11.5

func (s *Server) Logger() *glog.Logger

Logger returns the logger of the server.

func (*Server) Plugin ¶ added in v1.11.4

func (s *Server) Plugin(plugin ...Plugin)

Plugin adds plugin to server.

func (*Server) Run ¶

func (s *Server) Run()

Run starts server listening in blocking way. It's commonly used for single server situation.

func (*Server) ServeHTTP ¶ added in v1.12.2

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is the default handler for http request. It should not create new goroutine handling the request as it's called by am already created new goroutine from http.Server.

This function also make serve implementing the interface of http.Handler.

func (*Server) SetAccessLogEnabled ¶

func (s *Server) SetAccessLogEnabled(enabled bool)

SetAccessLogEnabled enables/disables the access log.

func (*Server) SetAddr ¶

func (s *Server) SetAddr(address string)

SetAddr sets the listening address for the server. The address is like ':80', '0.0.0.0:80', '127.0.0.1:80', '180.18.99.10:80', etc.

func (*Server) SetClientMaxBodySize ¶ added in v1.12.3

func (s *Server) SetClientMaxBodySize(maxSize int64)

SetClientMaxBodySize sets the ClientMaxBodySize for server.

func (*Server) SetConfig ¶

func (s *Server) SetConfig(c ServerConfig) error

SetConfig sets the configuration for the server.

func (*Server) SetConfigWithMap ¶

func (s *Server) SetConfigWithMap(m map[string]interface{}) error

SetConfigWithMap sets the configuration for the server using map.

func (*Server) SetCookieDomain ¶

func (s *Server) SetCookieDomain(domain string)

SetCookieDomain sets the CookieDomain for server.

func (*Server) SetCookieMaxAge ¶

func (s *Server) SetCookieMaxAge(ttl time.Duration)

SetCookieMaxAge sets the CookieMaxAge for server.

func (*Server) SetCookiePath ¶

func (s *Server) SetCookiePath(path string)

SetCookiePath sets the CookiePath for server.

func (*Server) SetDumpRouterMap ¶ added in v1.10.0

func (s *Server) SetDumpRouterMap(enabled bool)

SetDumpRouterMap sets the DumpRouterMap for server. If DumpRouterMap is enabled, it automatically dumps the route map when server starts.

func (*Server) SetErrorLogEnabled ¶

func (s *Server) SetErrorLogEnabled(enabled bool)

SetErrorLogEnabled enables/disables the error log.

func (*Server) SetErrorStack ¶

func (s *Server) SetErrorStack(enabled bool)

SetErrorStack enables/disables the error stack feature.

func (*Server) SetFileServerEnabled ¶

func (s *Server) SetFileServerEnabled(enabled bool)

SetFileServerEnabled enables/disables the static file service. It's the main switch for the static file service. When static file service configuration functions like SetServerRoot, AddSearchPath and AddStaticPath are called, this configuration is automatically enabled.

func (*Server) SetFormParsingMemory ¶ added in v1.9.2

func (s *Server) SetFormParsingMemory(maxMemory int64)

SetFormParsingMemory sets the FormParsingMemory for server.

func (*Server) SetHTTPSAddr ¶

func (s *Server) SetHTTPSAddr(address string)

SetHTTPSAddr sets the HTTPS listening ports for the server.

func (*Server) SetHTTPSPort ¶

func (s *Server) SetHTTPSPort(port ...int)

SetHTTPSPort sets the HTTPS listening ports for the server. The listening ports can be multiple like: SetHTTPSPort(443, 500).

func (*Server) SetIdleTimeout ¶

func (s *Server) SetIdleTimeout(t time.Duration)

SetIdleTimeout sets the IdleTimeout for the server.

func (*Server) SetIndexFiles ¶

func (s *Server) SetIndexFiles(indexFiles []string)

SetIndexFiles sets the index files for server.

func (*Server) SetIndexFolder ¶

func (s *Server) SetIndexFolder(enabled bool)

SetIndexFolder enables/disables listing the sub-files if requesting a directory.

func (*Server) SetKeepAlive ¶

func (s *Server) SetKeepAlive(enabled bool)

SetKeepAlive sets the KeepAlive for the server.

func (*Server) SetLogPath ¶

func (s *Server) SetLogPath(path string)

SetLogPath sets the log path for server. It logs content to file only if the log path is set.

func (*Server) SetLogStdout ¶

func (s *Server) SetLogStdout(enabled bool)

SetLogStdout sets whether output the logging content to stdout.

func (*Server) SetMaxHeaderBytes ¶

func (s *Server) SetMaxHeaderBytes(b int)

SetMaxHeaderBytes sets the MaxHeaderBytes for the server.

func (*Server) SetNameToUriType ¶

func (s *Server) SetNameToUriType(t int)

SetNameToUriType sets the NameToUriType for server.

func (*Server) SetPort ¶

func (s *Server) SetPort(port ...int)

SetPort sets the listening ports for the server. The listening ports can be multiple like: SetPort(80, 8080).

func (*Server) SetReadTimeout ¶

func (s *Server) SetReadTimeout(t time.Duration)

SetReadTimeout sets the ReadTimeout for the server.

func (*Server) SetRewrite ¶

func (s *Server) SetRewrite(uri string, rewrite string)

SetRewrite sets rewrites for static URI for server.

func (*Server) SetRewriteMap ¶

func (s *Server) SetRewriteMap(rewrites map[string]string)

SetRewriteMap sets the rewrite map for server.

func (*Server) SetRouteOverWrite ¶ added in v1.10.1

func (s *Server) SetRouteOverWrite(enabled bool)

SetRouteOverWrite sets the RouteOverWrite for server.

func (*Server) SetServerAgent ¶

func (s *Server) SetServerAgent(agent string)

SetServerAgent sets the ServerAgent for the server.

func (*Server) SetServerRoot ¶

func (s *Server) SetServerRoot(root string)

SetServerRoot sets the document root for static service.

func (*Server) SetSessionIdName ¶

func (s *Server) SetSessionIdName(name string)

SetSessionIdName sets the SessionIdName for server.

func (*Server) SetSessionMaxAge ¶

func (s *Server) SetSessionMaxAge(ttl time.Duration)

SetSessionMaxAge sets the SessionMaxAge for server.

func (*Server) SetSessionStorage ¶

func (s *Server) SetSessionStorage(storage gsession.Storage)

SetSessionStorage sets the SessionStorage for server.

func (*Server) SetTLSConfig ¶

func (s *Server) SetTLSConfig(tlsConfig *tls.Config)

SetTLSConfig sets custom TLS configuration and enables HTTPS feature for the server.

func (*Server) SetView ¶

func (s *Server) SetView(view *gview.View)

SetView sets the View for the server.

func (*Server) SetWriteTimeout ¶

func (s *Server) SetWriteTimeout(t time.Duration)

SetWriteTimeout sets the WriteTimeout for the server.

func (*Server) Shutdown ¶

func (s *Server) Shutdown() error

Shutdown shuts down current server.

func (*Server) Start ¶

func (s *Server) Start() error

Start starts listening on configured port. This function does not block the process, you can use function Wait blocking the process.

func (*Server) Status ¶

func (s *Server) Status() int

Status retrieves and returns the server status.

func (*Server) Use ¶ added in v1.11.0

func (s *Server) Use(handlers ...HandlerFunc)

Use is alias of BindMiddlewareDefault. See BindMiddlewareDefault.

func (*UploadFile) Save ¶ added in v1.11.5

func (f *UploadFile) Save(dirPath string, randomlyRename ...bool) (filename string, err error)

Save saves the single uploading file to directory path and returns the saved file name.

The parameter <dirPath> should be a directory path or it returns error.

Note that it will OVERWRITE the target file if there's already a same name file exist.

func (UploadFiles) Save ¶ added in v1.11.5

func (fs UploadFiles) Save(dirPath string, randomlyRename ...bool) (filenames []string, err error)

Save saves all uploading files to specified directory path and returns the saved file names.

The parameter <dirPath> should be a directory path or it returns error.

The parameter <randomlyRename> specifies whether randomly renames all the file names.