README
¶
Husky
A Simple Router, HTTP, utility for golang
Installation
Use go get command:
go get github.com/ysugimoto/husky
Usage
Import and create app, and bind routes like Sinatra:
package main
import "github.com/ysugimoto/husky"
func main() {
// create app
app := husky.NewApp()
// bind routes as you need
app.Get("/", func(disp *husky.Dispatcher) {
disp.Output.SetStatus(200)
disp.Output.SetHeader("Content-Type", "text/plain")
disp.Output.Send("Hello, Husky!")
});
...
// start server
app.Serve()
}
That's all.
Configuration
Make config.yml at current directory (e.g main.go) to override config and write:
# listen address
host: 127.0.0.1
# listen port
port: 8888
# listen path
path: /
Will listen 127.0.0.1:8888.
Documentation
¶
Index ¶
- func NewApp() *app
- func NewWebSocketHandler(handler HuskyWebSocketHandler) websocket.Handler
- type Arguments
- func (a *Arguments) Alias(flag string, value string, defaultValue interface{})
- func (a *Arguments) GetCommandAt(index int) (v string, ok bool)
- func (a *Arguments) GetCommandSize() int
- func (a *Arguments) GetCommands() []string
- func (a *Arguments) GetOption(sign string) (v interface{}, ok bool)
- func (a *Arguments) Parse(args []string)
- type Config
- type Database
- func (d *Database) AllQuery() string
- func (d *Database) EnableLog(enable bool)
- func (d *Database) Get(table string) (rows *sql.Rows, err error)
- func (d *Database) GetRow(table string) (row *sql.Row)
- func (d *Database) Insert(table string, values map[string]interface{}) (result sql.Result, err error)
- func (d *Database) IsTrans() bool
- func (d *Database) LastQuery() string
- func (d *Database) Limit(limit int) *Database
- func (d *Database) Offset(offset int) *Database
- func (d *Database) Query(query string, bind ...interface{}) (rows *sql.Rows, err error)
- func (d *Database) QueryRow(query string, bind ...interface{}) (rows *sql.Row)
- func (d *Database) Select(columns ...string) *Database
- func (d *Database) TransBegin()
- func (d *Database) TransCommit()
- func (d *Database) TransRollback()
- func (d *Database) Update(table string, values map[string]interface{}) (result sql.Result, err error)
- func (d *Database) Where(field, operator string, bind interface{}) *Database
- type Dispatcher
- type HuskyHandler
- type HuskyWebSocketHandler
- type Input
- type Output
- type Router
- func (r *Router) Bind(method, route string, handler HuskyHandler)
- func (r *Router) BindWebSocket(route string, handler HuskyWebSocketHandler)
- func (r *Router) FindDispatcher(method, path string) (dispatcher *RouterInfo, notFound bool)
- func (r *Router) Send404(res http.ResponseWriter, req *http.Request)
- func (r *Router) SendDefault404(res http.ResponseWriter, req *http.Request)
- func (r *Router) ServeHTTP(res http.ResponseWriter, req *http.Request)
- type RouterInfo
- type Server
- type WebSocketDispatcher
- type WebSocketInfo
- type WebSocketManager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewWebSocketHandler ¶
func NewWebSocketHandler(handler HuskyWebSocketHandler) websocket.Handler
Types ¶
type Arguments ¶
type Arguments struct {
Commands []string
Options map[string]interface{}
Aliases map[string]aliasOption
}
func NewArguments ¶
func NewArguments() *Arguments
func (*Arguments) GetCommandSize ¶
func (*Arguments) GetCommands ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
func (*Database) TransBegin ¶
func (d *Database) TransBegin()
func (*Database) TransCommit ¶
func (d *Database) TransCommit()
func (*Database) TransRollback ¶
func (d *Database) TransRollback()
type Dispatcher ¶
func NewDispatcher ¶
func NewDispatcher(res http.ResponseWriter, req *http.Request) *Dispatcher
type HuskyHandler ¶
type HuskyHandler func(dispatcher *Dispatcher)
type HuskyWebSocketHandler ¶
type HuskyWebSocketHandler func(dispatcher *WebSocketDispatcher)
type Input ¶
type Input struct {
// contains filtered or unexported fields
}
func (*Input) GetRequest ¶
type Output ¶
type Output struct {
// contains filtered or unexported fields
}
func NewOutput ¶
func NewOutput(res http.ResponseWriter) *Output
func (*Output) IsHeadersSent ¶
func (*Output) SendHeader ¶
type Router ¶
type Router struct {
Routes []*RouterInfo
WebSockets []*WebSocketInfo
}
func (*Router) Bind ¶
func (r *Router) Bind(method, route string, handler HuskyHandler)
func (*Router) BindWebSocket ¶
func (r *Router) BindWebSocket(route string, handler HuskyWebSocketHandler)
func (*Router) FindDispatcher ¶
func (r *Router) FindDispatcher(method, path string) (dispatcher *RouterInfo, notFound bool)
func (*Router) SendDefault404 ¶
func (r *Router) SendDefault404(res http.ResponseWriter, req *http.Request)
type RouterInfo ¶
type RouterInfo struct {
Method []byte
Route string
Handler HuskyHandler
}
type WebSocketDispatcher ¶
type WebSocketDispatcher struct {
Id string
OnMessage func(msg string)
OnOpen func()
OnClose func()
// contains filtered or unexported fields
}
func NewWebSocketDispatcher ¶
func NewWebSocketDispatcher(ws *websocket.Conn) *WebSocketDispatcher
func (*WebSocketDispatcher) Broadcast ¶
func (w *WebSocketDispatcher) Broadcast(message []byte, ignores ...string) (err error)
func (*WebSocketDispatcher) Close ¶
func (w *WebSocketDispatcher) Close()
func (*WebSocketDispatcher) Send ¶
func (w *WebSocketDispatcher) Send(message []byte) (err error)
type WebSocketInfo ¶
type WebSocketManager ¶
type WebSocketManager struct {
// contains filtered or unexported fields
}
Source Files
Click to show internal directories.
Click to hide internal directories.