Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gorbit

package module

Go to main page

Versions in this module

v1

v1.0.0

Aug 5, 2026

v0

v0.1.0

Aug 5, 2026

Changes in this version

+ type CookieOptions struct

+ Domain string

+ Expires time.Time

+ HttpOnly bool

+ MaxAge int

+ Path string

+ SameSite http.SameSite

+ Secure bool

+ type Ctx struct

+ Keys map[string]any

+ Params map[string]string

+ Request *http.Request

+ Writer http.ResponseWriter

+ func (c *Ctx) Abort()

+ func (c *Ctx) AbortJSON(status int, data any)

+ func (c *Ctx) AbortStatus(status int)

+ func (c *Ctx) BadRequest(v any)

+ func (c *Ctx) BindJSON(v any) error

+ func (c *Ctx) Body() ([]byte, error)

+ func (c *Ctx) ContentType() string

+ func (c *Ctx) Cookie(name string) (string, error)

+ func (c *Ctx) Cookies() []*http.Cookie

+ func (c *Ctx) Created(v any)

+ func (c *Ctx) DeleteCookie(name string, options CookieOptions)

+ func (c *Ctx) Download(path, filename string)

+ func (c *Ctx) File(path string)

+ func (c *Ctx) FileUpload(name string) (multipart.File, *multipart.FileHeader, error)

+ func (c *Ctx) Forbidden(v any)

+ func (c *Ctx) Form(key string) string

+ func (c *Ctx) FormFile(name string) (*UploadedFile, error)

+ func (c *Ctx) Get(key string) (any, bool)

+ func (c *Ctx) HTML(status int, html string)

+ func (c *Ctx) Header(key string) string

+ func (c *Ctx) Headers() http.Header

+ func (c *Ctx) Host() string

+ func (c *Ctx) IP() string

+ func (c *Ctx) InternalServerError(v any)

+ func (c *Ctx) JSON(status int, data any)

+ func (c *Ctx) Method() string

+ func (c *Ctx) Next()

+ func (c *Ctx) NoContent()

+ func (c *Ctx) NotFound(v any)

+ func (c *Ctx) OK(v any)

+ func (c *Ctx) Param(name string) string

+ func (c *Ctx) Path() string

+ func (c *Ctx) Queries() map[string][]string

+ func (c *Ctx) Query(key string) string

+ func (c *Ctx) QueryDefault(key, defaultValue string) string

+ func (c *Ctx) Redirect(status int, url string)

+ func (c *Ctx) Scheme() string

+ func (c *Ctx) Set(key string, value any)

+ func (c *Ctx) SetCookie(cookie *http.Cookie)

+ func (c *Ctx) SetCookieValue(name string, value string, options CookieOptions)

+ func (c *Ctx) Status(status int) *Ctx

+ func (c *Ctx) String(status int, message string)

+ func (c *Ctx) Unauthorized(v any)

+ func (c *Ctx) UserAgent() string

+ type EventHandler func(*WSClient, json.RawMessage)

+ type Handler func(*Ctx)

+ type JSON map[string]any

+ type Packet struct

+ Data json.RawMessage

+ Event string

+ type Route struct

+ Handlers []Handler

+ Method string

+ ParamKeys []string

+ Path string

+ Segments []string

+ WSHandler WSHandler

+ WebSocket bool

+ type Router struct

+ func NewRouter() *Router

+ func (r *Router) DELETE(path string, handlers ...Handler)

+ func (r *Router) GET(path string, handlers ...Handler)

+ func (r *Router) OPTIONS(path string, handlers ...Handler)

+ func (r *Router) POST(path string, handlers ...Handler)

+ func (r *Router) PUT(path string, handlers ...Handler)

+ func (r *Router) Use(handlers ...Handler)

+ type Server struct

+ WS *WSManager

+ func New(port int) *Server

+ func (s *Server) DELETE(path string, handlers ...Handler)

+ func (s *Server) GET(path string, handlers ...Handler)

+ func (s *Server) Mount(prefix string, router *Router)

+ func (s *Server) OPTIONS(path string, handlers ...Handler)

+ func (s *Server) POST(path string, handlers ...Handler)

+ func (s *Server) PUT(path string, handlers ...Handler)

+ func (s *Server) Start() error

+ func (s *Server) Static(prefix, dir string)

+ func (s *Server) Use(h Handler)

+ type UploadedFile struct

+ ContentType string

+ File multipart.File

+ Filename string

+ Header *multipart.FileHeader

+ Size int64

+ func (f *UploadedFile) SaveTo(path string) error

+ type WSClient struct

+ Conn *coderws.Conn

+ Context context.Context

+ ID string

+ Values map[string]any

+ func (c *WSClient) Close() error

+ func (c *WSClient) Delete(key string)

+ func (c *WSClient) Emit(event string, data any) error

+ func (c *WSClient) EmitJSON(event string, v any) error

+ func (c *WSClient) Get(key string) (any, bool)

+ func (c *WSClient) Join(room string)

+ func (c *WSClient) Leave(room string)

+ func (c *WSClient) LeaveAll()

+ func (c *WSClient) Listen()

+ func (c *WSClient) On(event string, handler EventHandler)

+ func (c *WSClient) OnConnect(fn func(*WSClient))

+ func (c *WSClient) OnDisconnect(fn func(*WSClient))

+ func (c *WSClient) Raw(messageType coderws.MessageType, data []byte) error

+ func (c *WSClient) Set(key string, value any)

+ type WSHandler func(*WSClient)

+ type WSManager struct

+ func WS() *WSManager

+ func (m *WSManager) AddOrigins(origins ...string)

+ func (m *WSManager) AllowAllOrigins()

+ func (m *WSManager) Broadcast(room, event string, data any)

+ func (m *WSManager) Handle(path string, handler WSHandler)

+ func (m *WSManager) Options() *coderws.AcceptOptions

+ func (m *WSManager) SetOptions(options coderws.AcceptOptions)