libhttpserver

Documentation

Index

• func GetGUIFileContextFromContentType(contentTypeRaw string) (viewType keybase1.GUIViewType, invariance string)
• type Server
  • func New(appStateUpdater env.AppStateUpdater, config libkbfs.Config) (s *Server, err error)
  • func (s *Server) Address() (string, error)
  • func (s *Server) CurrentToken() (token string, err error)
  • func (s *Server) Shutdown()

Functions

func GetGUIFileContextFromContentType

func GetGUIFileContextFromContentType(contentTypeRaw string) (
	viewType keybase1.GUIViewType, invariance string)

GetGUIFileContextFromContentType returns necessary data used by GUI for displaying file previews.

The invariance here is derived from viewType, and later added into the url returned to GUI. When a file is requested from the the http server and an invariance field is specified, we make sure the viewType of the file we serve satisfies the invariance provided. This makes sure the viewType doesn't change between when GUI learnt about it and when GUI requested it over HTTP from the webview.

Types

type Server

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

Server is a local HTTP server for serving KBFS content over HTTP.

func New

func New(appStateUpdater env.AppStateUpdater, config libkbfs.Config) (
	s *Server, err error)

New creates and starts a new server.

func (*Server) Address

func (s *Server) Address() (string, error)

Address returns the address that the server is listening on.

func (*Server) CurrentToken

func (s *Server) CurrentToken() (token string, err error)

CurrentToken returns the currently valid token that a HTTP client can use to load content from the server.

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown shuts down the server.