Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

apis

package

Go to main page

Versions in this module

v0

v0.1.5

Aug 2, 2024

Changes in this version

+ func WalkWebsockets(ctx context.Context, socketPrefix string, ...) error

type Gateway

+ func (gw *Gateway) Middleware() services.MiddlewareFuncs

+ type Websocket struct

+ Conn net.Conn

+ ID string

+ Options WebsocketOptions

+ func ConnectWebsocket(ctx context.Context, connectionID string, opts WebsocketOptions) (*Websocket, error)

+ func (socket *Websocket) Active() bool

+ func (socket *Websocket) Close() error

+ func (socket *Websocket) Write(data []byte) error

+ func (socket *Websocket) WriteClose(data []byte) error

+ func (socket *Websocket) WriteJSON(value any) error

+ func (socket *Websocket) WriteText(data string) error

+ type WebsocketOptions struct

+ Logger *slog.Logger

+ OnClose func()

+ OnReadBinary func(ctx context.Context, socket *Websocket, data []byte)

+ OnReadContinuation func(ctx context.Context, socket *Websocket, data []byte)

+ OnReadText func(ctx context.Context, socket *Websocket, data []byte)

v0.1.4

Mar 7, 2024

Changes in this version

type GatewayOption

+ func WithCORS(options PreflightOptions) GatewayOption

+ type PreflightOptions cors.Options

v0.1.3

Mar 1, 2024

v0.1.2

Feb 21, 2024

Changes in this version

type GatewayOption

+ func WithNotFound(handler http.HandlerFunc) GatewayOption

v0.1.1

Jan 12, 2024

v0.1.0

Jan 12, 2024

Changes in this version

+ type Gateway struct

+ func NewGateway(address string, options ...GatewayOption) *Gateway

+ func (gw *Gateway) Listen() error

+ func (gw *Gateway) Register(endpoint services.Endpoint, route services.EndpointRoute)

+ func (gw *Gateway) Shutdown(ctx context.Context) error

+ func (gw *Gateway) Type() services.GatewayType

+ func (gw *Gateway) UseTLS() bool

+ type GatewayOption func(*Gateway)

+ func WithMiddleware(funcs ...HTTPMiddlewareFunc) GatewayOption

+ func WithTLSConfig(config *tls.Config) GatewayOption

+ func WithTLSFiles(certFile string, keyFile string) GatewayOption

+ type HTTPMiddlewareFunc func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

+ type HTTPMiddlewareFuncs []HTTPMiddlewareFunc

+ func (funcs HTTPMiddlewareFuncs) Append(functions ...HTTPMiddlewareFunc) HTTPMiddlewareFuncs

+ func (funcs HTTPMiddlewareFuncs) Then(handler http.HandlerFunc) http.HandlerFunc