g

Documentation

Index

• func Cfg(name ...string) *gcfg.Config
• func Client() *ghttp.Client
• func Config(name ...string) *gcfg.Config
• func DB(name ...string) gdb.DB
• func Dump(i ...interface{})
• func Export(i ...interface{}) string
• func GetLogLevel() int
• func I18n(name ...string) *gi18n.Manager
• func IsEmpty(value interface{}) bool
• func IsNil(value interface{}, traceSource ...bool) bool
• func Listen()
• func Log(name ...string) *glog.Logger
• func Model(tableNameOrStruct ...interface{}) *gdb.Model
• func Redis(name ...string) *gredis.Redis
• func RequestFromCtx(ctx context.Context) *ghttp.Request
• func Res(name ...string) *gres.Resource
• func Resource(name ...string) *gres.Resource
• func Server(name ...interface{}) *ghttp.Server
• func SetDebug(enabled bool)
• func SetLogLevel(level int)
• func SetServerGraceful(enabled bool)
• func TCPServer(name ...interface{}) *gtcp.Server
• func Table(tableNameOrStruct ...interface{}) *gdb.Model
• func Throw(exception interface{})
• func Try(try func()) (err error)
• func TryCatch(try func(), catch ...func(exception error))
• func UDPServer(name ...interface{}) *gudp.Server
• func Validator() *gvalid.Validator
• func View(name ...string) *gview.View
• func Wait()
• type Array
• type ArrayAny
• type ArrayInt
• type ArrayStr
• type Ctx
• type List
• type ListAnyAny
• type ListAnyBool
• type ListAnyInt
• type ListAnyStr
• type ListIntAny
• type ListIntBool
• type ListIntInt
• type ListIntStr
• type ListStrAny
• type ListStrBool
• type ListStrInt
• type ListStrStr
• type Map
• type MapAnyAny
• type MapAnyBool
• type MapAnyInt
• type MapAnyStr
• type MapIntAny
• type MapIntBool
• type MapIntInt
• type MapIntStr
• type MapStrAny
• type MapStrBool
• type MapStrInt
• type MapStrStr
• type Slice
• type SliceAny
• type SliceInt
• type SliceStr
• type Var
  • func NewVar(i interface{}, safe ...bool) *Var

Examples

• Server

Functions

func Cfg

func Cfg(name ...string) *gcfg.Config

Cfg is alias of Config. See Config.

func Client

func Client() *ghttp.Client

Client is a convenience function, which creates and returns a new HTTP client.

func Config

func Config(name ...string) *gcfg.Config

Config returns an instance of config object with specified name.

func DB

func DB(name ...string) gdb.DB

DB returns an instance of database ORM object with specified configuration group name.

func Dump

func Dump(i ...interface{})

Dump dumps a variable to stdout with more manually readable.

func Export

func Export(i ...interface{}) string

Export exports a variable to string with more manually readable.

func GetLogLevel

func GetLogLevel() int

GetLogLevel returns the global logging level. Deprecated, use functions of package glog or g.Log() instead.

func I18n

func I18n(name ...string) *gi18n.Manager

I18n returns an instance of gi18n.Manager. The parameter <name> is the name for the instance.

func IsEmpty

func IsEmpty(value interface{}) bool

IsEmpty checks whether given <value> empty. It returns true if <value> is in: 0, nil, false, "", len(slice/map/chan) == 0. Or else it returns true.

func IsNil

func IsNil(value interface{}, traceSource ...bool) bool

IsNil checks whether given <value> is nil. Parameter <traceSource> is used for tracing to the source variable if given <value> is type of a pinter that also points to a pointer. It returns nil if the source is nil when <traceSource> is true. Note that it might use reflect feature which affects performance a little bit.

func Listen

func Listen()

Listen is an alias of gproc.Listen, which handles the signals received and automatically calls registered signal handler functions. It blocks until shutdown signals received and all registered shutdown handlers done.

func Log

func Log(name ...string) *glog.Logger

Log returns an instance of glog.Logger. The parameter <name> is the name for the instance.

func Model

func Model(tableNameOrStruct ...interface{}) *gdb.Model

Model creates and returns a model based on configuration of default database group.

func Redis

func Redis(name ...string) *gredis.Redis

Redis returns an instance of redis client with specified configuration group name.

func RequestFromCtx

func RequestFromCtx(ctx context.Context) *ghttp.Request

RequestFromCtx retrieves and returns the Request object from context.

func Res

func Res(name ...string) *gres.Resource

Res is alias of Resource. See Resource.

func Resource

func Resource(name ...string) *gres.Resource

Resource returns an instance of Resource. The parameter <name> is the name for the instance.

func Server

func Server(name ...interface{}) *ghttp.Server

Server returns an instance of http server with specified name.

Example

package main

import (
	"github.com/gogf/gf/frame/g"
	"github.com/gogf/gf/net/ghttp"
)

func main() {
	// A hello world example.
	s := g.Server()
	s.BindHandler("/", func(r *ghttp.Request) {
		r.Response.Write("hello world")
	})
	s.SetPort(8999)
	s.Run()
}

func SetDebug

func SetDebug(enabled bool)

SetDebug enables/disables the GoFrame internal logging manually. Note that this function is not concurrent safe, be aware of the DATA RACE, which means you should call this function in your boot but not the runtime.

func SetLogLevel

func SetLogLevel(level int)

SetLogLevel sets the logging level globally. Deprecated, use functions of package glog or g.Log() instead.

func SetServerGraceful

func SetServerGraceful(enabled bool)

SetServerGraceful enables/disables graceful reload feature of http Web Server. This feature is disabled in default. Deprecated, use configuration of ghttp.Server for controlling this feature.

func TCPServer

func TCPServer(name ...interface{}) *gtcp.Server

TCPServer returns an instance of tcp server with specified name.

func Table

func Table(tableNameOrStruct ...interface{}) *gdb.Model

Table is alias of Model. The database component is designed not only for relational databases but also for NoSQL databases in the future. The name "Table" is not proper for that purpose any more. Deprecated, use Model instead.

func Throw

func Throw(exception interface{})

Throw throws a exception, which can be caught by TryCatch function. It always be used in TryCatch function.

func Try

func Try(try func()) (err error)

Try implements try... logistics using internal panic...recover. It returns error if any exception occurs, or else it returns nil.

func TryCatch

func TryCatch(try func(), catch ...func(exception error))

TryCatch implements try...catch... logistics using internal panic...recover. It automatically calls function <catch> if any exception occurs ans passes the exception as an error.

func UDPServer

func UDPServer(name ...interface{}) *gudp.Server

UDPServer returns an instance of udp server with specified name.

func Validator

func Validator() *gvalid.Validator

Validator is a convenience function, which creates and returns a new validation manager object.

func View

func View(name ...string) *gview.View

View returns an instance of template engine object with specified name.

func Wait

func Wait()

Wait is an alias of ghttp.Wait, which blocks until all the web servers shutdown. It's commonly used in multiple servers situation.

Types

type Array

type Array = []interface{} // Array is alias of frequently-used slice type []interface{}.

type ArrayAny

type ArrayAny = []interface{} // ArrayAny is alias of frequently-used slice type []interface{}.

type ArrayInt

type ArrayInt = []int // ArrayInt is alias of frequently-used slice type []int.

type ArrayStr

type ArrayStr = []string // ArrayStr is alias of frequently-used slice type []string.

type Ctx

type Ctx = context.Context // Ctx is alias of frequently-used context.Context.

type List

type List = []Map // List is alias of frequently-used slice type []Map.

type ListAnyAny

type ListAnyAny = []MapAnyAny // ListAnyAny is alias of frequently-used slice type []MapAnyAny.

type ListAnyBool

type ListAnyBool = []MapAnyBool // ListAnyBool is alias of frequently-used slice type []MapAnyBool.

type ListAnyInt

type ListAnyInt = []MapAnyInt // ListAnyInt is alias of frequently-used slice type []MapAnyInt.

type ListAnyStr

type ListAnyStr = []MapAnyStr // ListAnyStr is alias of frequently-used slice type []MapAnyStr.

type ListIntAny

type ListIntAny = []MapIntAny // ListIntAny is alias of frequently-used slice type []MapIntAny.

type ListIntBool

type ListIntBool = []MapIntBool // ListIntBool is alias of frequently-used slice type []MapIntBool.

type ListIntInt

type ListIntInt = []MapIntInt // ListIntInt is alias of frequently-used slice type []MapIntInt.

type ListIntStr

type ListIntStr = []MapIntStr // ListIntStr is alias of frequently-used slice type []MapIntStr.

type ListStrAny

type ListStrAny = []MapStrAny // ListStrAny is alias of frequently-used slice type []MapStrAny.

type ListStrBool

type ListStrBool = []MapStrBool // ListStrBool is alias of frequently-used slice type []MapStrBool.

type ListStrInt

type ListStrInt = []MapStrInt // ListStrInt is alias of frequently-used slice type []MapStrInt.

type ListStrStr

type ListStrStr = []MapStrStr // ListStrStr is alias of frequently-used slice type []MapStrStr.

type Map

type Map = map[string]interface{} // Map is alias of frequently-used map type map[string]interface{}.

type MapAnyAny

type MapAnyAny = map[interface{}]interface{} // MapAnyAny is alias of frequently-used map type map[interface{}]interface{}.

type MapAnyBool

type MapAnyBool = map[interface{}]bool // MapAnyBool is alias of frequently-used map type map[interface{}]bool.

type MapAnyInt

type MapAnyInt = map[interface{}]int // MapAnyInt is alias of frequently-used map type map[interface{}]int.

type MapAnyStr

type MapAnyStr = map[interface{}]string // MapAnyStr is alias of frequently-used map type map[interface{}]string.

type MapIntAny

type MapIntAny = map[int]interface{} // MapIntAny is alias of frequently-used map type map[int]interface{}.

type MapIntBool

type MapIntBool = map[int]bool // MapIntBool is alias of frequently-used map type map[int]bool.

type MapIntInt

type MapIntInt = map[int]int // MapIntInt is alias of frequently-used map type map[int]int.

type MapIntStr

type MapIntStr = map[int]string // MapIntStr is alias of frequently-used map type map[int]string.

type MapStrAny

type MapStrAny = map[string]interface{} // MapStrAny is alias of frequently-used map type map[string]interface{}.

type MapStrBool

type MapStrBool = map[string]bool // MapStrBool is alias of frequently-used map type map[string]bool.

type MapStrInt

type MapStrInt = map[string]int // MapStrInt is alias of frequently-used map type map[string]int.

type MapStrStr

type MapStrStr = map[string]string // MapStrStr is alias of frequently-used map type map[string]string.

type Slice

type Slice = []interface{} // Slice is alias of frequently-used slice type []interface{}.

type SliceAny

type SliceAny = []interface{} // SliceAny is alias of frequently-used slice type []interface{}.

type SliceInt

type SliceInt = []int // SliceInt is alias of frequently-used slice type []int.

type SliceStr

type SliceStr = []string // SliceStr is alias of frequently-used slice type []string.

type Var

type Var = gvar.Var // Var is a universal variable interface, like generics.

func NewVar

func NewVar(i interface{}, safe ...bool) *Var

NewVar returns a gvar.Var.