https://github.com/hslam/rum
Package rum implements an HTTP server. The rum server is compatible with net/http and faster than net/http.
https://github.com/hslam/rum
epoll fast go golang http kqueue netpoll server
Last synced: 2 months ago
JSON representation
Package rum implements an HTTP server. The rum server is compatible with net/http and faster than net/http.
- Host: GitHub
- URL: https://github.com/hslam/rum
- Owner: hslam
- License: mit
- Created: 2020-11-20T07:57:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-14T09:44:32.000Z (about 2 years ago)
- Last Synced: 2024-07-02T20:17:09.480Z (11 months ago)
- Topics: epoll, fast, go, golang, http, kqueue, netpoll, server
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rum
[](https://pkg.go.dev/github.com/hslam/rum)
[](https://github.com/hslam/rum/actions)
[](https://codecov.io/gh/hslam/rum)
[](https://goreportcard.com/report/github.com/hslam/rum)
[](https://github.com/hslam/rum/blob/master/LICENSE)
Package rum implements an HTTP server. The rum server is compatible with net/http and faster than net/http.
## Features
* Fully compatible with the http.HandlerFunc interface.
* Support other router that implements the http.Handler interface.
* [Epoll/Kqueue](https://github.com/hslam/netpoll "netpoll")
* [HTTP request](https://github.com/hslam/request "request")
* [HTTP response](https://github.com/hslam/response "response")
* [HTTP request multiplexer](https://github.com/hslam/mux "mux")
* [HTTP handler](https://github.com/hslam/handler "handler")
## [Benchmark](http://github.com/hslam/http-benchmark "http-benchmark")
## Get started
### Install
```
go get github.com/hslam/rum
```
### Import
```
import "github.com/hslam/rum"
```
### Usage
#### Simple Example
```go
package main
import (
"github.com/hslam/rum"
"net/http"
)
func main() {
m := rum.New()
m.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World"))
})
m.Run(":8080")
}
```
curl http://localhost:8080
```
Hello World
```
#### Example
```go
package main
import (
"github.com/hslam/rum"
"net/http"
)
func main() {
m := rum.New()
m.SetPoll(true)
m.Recovery(rum.Recovery)
m.NotFound(func(w http.ResponseWriter, r *http.Request) {
http.Error(w, "Not Found : "+r.URL.String(), http.StatusNotFound)
})
m.Use(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Access-Control-Allow-Origin", "*")
})
m.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World"))
})
m.HandleFunc("/hello/:name", func(w http.ResponseWriter, r *http.Request) {
params := m.Params(r)
w.Write([]byte("Hello " + params["name"]))
}).GET()
m.Group("/group", func(m *rum.Mux) {
m.HandleFunc("/foo/:id", func(w http.ResponseWriter, r *http.Request) {
params := m.Params(r)
w.Write([]byte("group/foo id:" + params["id"]))
}).GET()
m.HandleFunc("/bar/:id", func(w http.ResponseWriter, r *http.Request) {
params := m.Params(r)
w.Write([]byte("group/bar id:" + params["id"]))
}).GET()
})
m.Run(":8080")
}
```
curl http://localhost:8080/hello/rum
```
Hello rum
```
curl http://localhost:8080/group/foo/1
```
group/foo id:1
```
curl http://localhost:8080/group/bar/2
```
group/bar id:2
```
#### Use Other Router Example
The router must implement the http.Handler interface, for example using the http.ServeMux.
```go
package main
import (
"github.com/hslam/rum"
"net/http"
)
func main() {
router := http.NewServeMux()
router.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Hello World"))
})
server := rum.New()
server.Handler = router
server.Run(":8080")
}
```
### License
This package is licensed under a MIT license (Copyright (c) 2020 Meng Huang)
### Author
rum was written by Meng Huang.