server

Documentation

Overview

Package server provides utilities for creating a functioning and useful Gemini server

Index

• type Handler
• type Request
  • func (r *Request) Error(code int, message string) error
  • func (r *Request) Gemtext(source string) error
  • func (r *Request) GemtextFile(path string) error
  • func (r *Request) GetClientCertificates() []*x509.Certificate
• type Server
  • func New() *Server
  • func (s *Server) Close() error
  • func (s *Server) ListenAndServe(addr string, tlsConfig *tls.Config) error
  • func (s *Server) RegisterHandler(path string, handler Handler)
  • func (s *Server) RegisterTitanHandler(path string, handler TitanHandler)
• type TitanHandler
• type TitanRequest

Types

type Handler

type Handler func(request Request)

A Handler is a function to handle a Request by calling its various methods. The function is called when a request that it can handle is made, as outlined in Server.RegisterHandler

type Request

type Request struct {
	// URI contains a [url.URL] object corresponding to the URL of the request.
	URI url.URL
	// Params contains a map of URL params passed into the request. Nil if there are no params.
	Params map[string]string
	// contains filtered or unexported fields
}

Request wraps a Gemini request.

func (*Request) Error

func (r *Request) Error(code int, message string) error

Error responds with an error code and message After calling this method, the Request has been terminated.

func (*Request) Gemtext

func (r *Request) Gemtext(source string) error

Gemtext responds using a gemtext string and status code 20. After calling this method, the Request has been terminated.

func (*Request) GemtextFile

func (r *Request) GemtextFile(path string) error

GemtextFile responds using gemtext from a file and status code 20. After calling this method, the Request has been terminated.

func (*Request) GetClientCertificates

func (r *Request) GetClientCertificates() []*x509.Certificate

GetClientCertificates retrieves the client certificate(s) for the Request

type Server

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

A Server contains information required to run a TCP/TLS service capable of serving Gemini content over the internet

func New

func New() *Server

New creates a new Server

func (*Server) Close

func (s *Server) Close() error

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(addr string, tlsConfig *tls.Config) error

ListenAndServe starts the Server running on a specific port using the provided TLS configuration

func (*Server) RegisterHandler

func (s *Server) RegisterHandler(path string, handler Handler)

RegisterHandler sets up a Handler to handle any Request that comes to a path

func (*Server) RegisterTitanHandler

func (s *Server) RegisterTitanHandler(path string, handler TitanHandler)

RegisterTitanHandler sets up a TitanHandler to handle any TitanRequest that comes to a path

type TitanHandler

type TitanHandler func(request TitanRequest)

A TitanHandler is a function to handle a TitanRequest by calling its various methods. The function is called when a titan request that it can handle is made as outlined in Server.RegisterTitanHandler

type TitanRequest

type TitanRequest struct {
	Request
	// Token contains the answer to the security question, or an empty string
	Token string
	// MIMEType contains the MIME type of the data. Defaults to "text/gemini"
	MIMEType string
	// Body contains the data sent by the client
	Body []byte
}

TitanRequest wraps a Titan request.

Contains Request, so can be used like a Gemini request as well.