rtnl

Documentation

Index

• func GetBearerToken(c *gin.Context) (tks string, err error)
• func ParseToken(token string) (clientID, secret string, err error)
• type Render
  • func NewRender(fsys fs.FS, pattern string, includes ...string) (render *Render, err error)
  • func (r *Render) AddPattern(fsys fs.FS, pattern string, includes ...string) (err error)
  • func (r *Render) Instance(name string, data any) render.Render
• type Server
  • func New(conf config.Config) (s *Server, err error)
  • func (s *Server) Authenticate(c *gin.Context)
  • func (s *Server) Available() gin.HandlerFunc
  • func (s *Server) DeleteShortURL(c *gin.Context)
  • func (s *Server) Healthz(c *gin.Context)
  • func (s *Server) Index(c *gin.Context)
  • func (s *Server) IsHealthy() bool
  • func (s *Server) IsReady() bool
  • func (s *Server) List(c *gin.Context)
  • func (s *Server) Login(c *gin.Context)
  • func (s *Server) LoginPage(c *gin.Context)
  • func (s *Server) NotAllowed(c *gin.Context)
  • func (s *Server) NotFound(c *gin.Context)
  • func (s *Server) Readyz(c *gin.Context)
  • func (s *Server) Redirect(c *gin.Context)
  • func (s *Server) Routes(router *gin.Engine) (err error)
  • func (s *Server) Serve() (err error)
  • func (s *Server) SetHealthy(status bool)
  • func (s *Server) SetReady(status bool)
  • func (s *Server) ShortURLDetail(c *gin.Context)
  • func (s *Server) ShortURLInfo(c *gin.Context)
  • func (s *Server) ShortURLList(c *gin.Context)
  • func (s *Server) ShortenURL(c *gin.Context)
  • func (s *Server) Shutdown(ctx context.Context) (err error)
  • func (s *Server) Status(c *gin.Context)
  • func (s *Server) URL() string
  • func (s *Server) Updates(c *gin.Context)
  • func (s *Server) Uptime() time.Duration

Functions

func GetBearerToken

func GetBearerToken(c *gin.Context) (tks string, err error)

func ParseToken

func ParseToken(token string) (clientID, secret string, err error)

Types

type Render

type Render struct {
	// contains filtered or unexported fields
}

func NewRender

func NewRender(fsys fs.FS, pattern string, includes ...string) (render *Render, err error)

func (*Render) AddPattern

func (r *Render) AddPattern(fsys fs.FS, pattern string, includes ...string) (err error)

func (*Render) Instance

func (r *Render) Instance(name string, data any) render.Render

type Server

type Server struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Implements the link shortening service and API.

func New

func New(conf config.Config) (s *Server, err error)

func (*Server) Authenticate

func (s *Server) Authenticate(c *gin.Context)

func (*Server) Available

func (s *Server) Available() gin.HandlerFunc

Available is middleware that uses healthy boolean to return a service unavailable http status code if the server is shutting down or in maintenance mode. This middleware must be fairly early on in the chain to ensure that complex handling does not slow the shutdown of the server.

func (*Server) DeleteShortURL

func (s *Server) DeleteShortURL(c *gin.Context)

func (*Server) Healthz

func (s *Server) Healthz(c *gin.Context)

func (*Server) Index

func (s *Server) Index(c *gin.Context)

func (*Server) IsHealthy

func (s *Server) IsHealthy() bool

Determines if the server is healthy or not.

func (*Server) IsReady

func (s *Server) IsReady() bool

Determines if the server is ready or not.

func (*Server) List

func (s *Server) List(c *gin.Context)

func (*Server) Login

func (s *Server) Login(c *gin.Context)

func (*Server) LoginPage

func (s *Server) LoginPage(c *gin.Context)

func (*Server) NotAllowed

func (s *Server) NotAllowed(c *gin.Context)

func (*Server) NotFound

func (s *Server) NotFound(c *gin.Context)

func (*Server) Readyz

func (s *Server) Readyz(c *gin.Context)

func (*Server) Redirect

func (s *Server) Redirect(c *gin.Context)

func (*Server) Routes

func (s *Server) Routes(router *gin.Engine) (err error)

func (*Server) Serve

func (s *Server) Serve() (err error)

func (*Server) SetHealthy

func (s *Server) SetHealthy(status bool)

Set the server health state to the status bool.

func (*Server) SetReady

func (s *Server) SetReady(status bool)

Set the server ready state to the status bool.

func (*Server) ShortURLDetail

func (s *Server) ShortURLDetail(c *gin.Context)

func (*Server) ShortURLInfo

func (s *Server) ShortURLInfo(c *gin.Context)

func (*Server) ShortURLList

func (s *Server) ShortURLList(c *gin.Context)

func (*Server) ShortenURL

func (s *Server) ShortenURL(c *gin.Context)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) (err error)

func (*Server) Status

func (s *Server) Status(c *gin.Context)

func (*Server) URL

func (s *Server) URL() string

URL returns the URL of the server determined by the socket addr.

func (*Server) Updates

func (s *Server) Updates(c *gin.Context)

func (*Server) Uptime

func (s *Server) Uptime() time.Duration

Compute how long the server has been running for status calls.