💾 Archived View for source.community › ckaznocha › gemini › blob › main › doc.go captured on 2022-06-03 at 23:33:07. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

                                                         .
,-. ,-. . . ,-. ,-. ,-.    ,-. ,-. ,-,-. ,-,-. . . ,-. . |- . .
`-. | | | | |   |   |-'    |   | | | | | | | | | | | | | |  | |
`-' `-' `-^ '   `-' `-' :: `-' `-' ' ' ' ' ' ' `-^ ' ' ' `' `-|
                                                             /|
                                                            `-'

ckaznocha / gemini

git clone https://source.community/ckaznocha/gemini.git

Branches

Log

Tree

/doc.go (main)

↑ /

blob

View raw contents of /doc.go (main)

────╮
   1│ /*
   2│ Package gemini provides a server implementation for the Gemini protocol.
   3│ 
   4│ This package should feel familiar to people comfortable with Go's net/http
   5│ however it differs where it makes sense.
   6│ 
   7│ Handlers receive a context directly rather than attaching it to a request.
   8│ 
   9│ There is no support for starting a server without TLS.
  10│ 
  11│ The ResponseWriter provides methods for handing different response types rather
  12│ than a single abstract response.
  13│ 
  14│ An example of a server using this package. The server greets a user, accepting
  15│ input from either a prompt or a client cert. The example includes a graceful
  16│ shutdown, log handler, and a shutdown func:
  17│ 	package main
  18│ 
  19│ 	import (
  20│ 		"context"
  21│ 		"fmt"
  22│ 		"log"
  23│ 		"os"
  24│ 		"os/signal"
  25│ 
  26│ 		"source.community/ckaznocha/gemini"
  27│ 	)
  28│ 
  29│ 	func greetHandler(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
  30│ 		var name string
  31│ 
  32│ 		switch {
  33│ 		case r.Subject != nil:
  34│ 			name = r.Subject.CommonName
  35│ 		case r.URI.Query != "":
  36│ 			name = r.URI.RawQuery
  37│ 		default:
  38│ 			w.Input(ctx, "What is your name?", false)
  39│ 
  40│ 			return
  41│ 		}
  42│ 
  43│ 		fmt.Fprintf(w.Success(ctx, ""), "Hello, %s!", name)
  44│ 	}
  45│ 
  46│ 	func main() {
  47│ 		logger := log.New(
  48│ 			os.Stdout,
  49│ 			"[Gemini Example] ",
  50│ 			log.LstdFlags|log.LUTC|log.Lmicroseconds|log.Lmsgprefix|log.Lshortfile,
  51│ 		)
  52│ 
  53│ 		logger.Println("Server starting")
  54│ 
  55│ 		mux := gemini.NewServeMux()
  56│ 
  57│ 		mux.HandleFunc("/greet", greetHandler)
  58│ 
  59│ 		s := &gemini.Server{
  60│ 			Handler: mux,
  61│ 			LogHandler: func(message string, isError bool) {
  62│ 				logger.Printf("gemini server: %s", message)
  63│ 			},
  64│ 		}
  65│ 
  66│ 		s.RegisterOnShutdown(func() {
  67│ 			s.LogHandler("shutting down", false)
  68│ 		})
  69│ 
  70│ 		ctx, cancel := context.WithCancel(context.Background())
  71│ 		defer cancel()
  72│ 
  73│ 		logger.Println("Server started")
  74│ 
  75│ 		go func() {
  76│ 			defer cancel()
  77│ 
  78│ 			s.LogHandler("starting", false)
  79│ 			err := s.ListenAndServeTLS("", "testdata/cert.pem", "testdata/key.pem")
  80│ 			s.LogHandler(fmt.Sprintf("exited: %s\n", err), true)
  81│ 		}()
  82│ 
  83│ 		ctx, stop := signal.NotifyContext(ctx, os.Interrupt)
  84│ 		defer stop()
  85│ 
  86│ 		<-ctx.Done()
  87│ 
  88│ 		logger.Println("Shutdown starting")
  89│ 		defer logger.Println("Shutdown complete")
  90│ 
  91│ 		if err := s.Shutdown(context.Background()); err != nil {
  92│ 			logger.Printf("Error during shutdown: %s\n", err)
  93│ 		}
  94│ 	}
  95│ 
  96│ */
  97│ package gemini
────╯

· · ·

info@source.community