💾 Archived View for source.community › ckaznocha › gemini › blob › main › doc.go captured on 2024-05-10 at 11:01:35. 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│ 
  18│ 	package main
  19│ 
  20│ 	import (
  21│ 		"context"
  22│ 		"fmt"
  23│ 		"log"
  24│ 		"os"
  25│ 		"os/signal"
  26│ 
  27│ 		"source.community/ckaznocha/gemini"
  28│ 	)
  29│ 
  30│ 	func greetHandler(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
  31│ 		var name string
  32│ 
  33│ 		switch {
  34│ 		case r.Subject != nil:
  35│ 			name = r.Subject.CommonName
  36│ 		case r.URI.Query != "":
  37│ 			name = r.URI.RawQuery
  38│ 		default:
  39│ 			w.Input(ctx, "What is your name?", false)
  40│ 
  41│ 			return
  42│ 		}
  43│ 
  44│ 		fmt.Fprintf(w.Success(ctx, ""), "Hello, %s!", name)
  45│ 	}
  46│ 
  47│ 	func main() {
  48│ 		logger := log.New(
  49│ 			os.Stdout,
  50│ 			"[Gemini Example] ",
  51│ 			log.LstdFlags|log.LUTC|log.Lmicroseconds|log.Lmsgprefix|log.Lshortfile,
  52│ 		)
  53│ 
  54│ 		logger.Println("Server starting")
  55│ 
  56│ 		mux := gemini.NewServeMux()
  57│ 
  58│ 		mux.HandleFunc("/greet", greetHandler)
  59│ 
  60│ 		s := &gemini.Server{
  61│ 			Handler: mux,
  62│ 			LogHandler: func(message string, isError bool) {
  63│ 				logger.Printf("gemini server: %s", message)
  64│ 			},
  65│ 		}
  66│ 
  67│ 		s.RegisterOnShutdown(func() {
  68│ 			s.LogHandler("shutting down", false)
  69│ 		})
  70│ 
  71│ 		ctx, cancel := context.WithCancel(context.Background())
  72│ 		defer cancel()
  73│ 
  74│ 		logger.Println("Server started")
  75│ 
  76│ 		go func() {
  77│ 			defer cancel()
  78│ 
  79│ 			s.LogHandler("starting", false)
  80│ 			err := s.ListenAndServeTLS("", "testdata/cert.pem", "testdata/key.pem")
  81│ 			s.LogHandler(fmt.Sprintf("exited: %s\n", err), true)
  82│ 		}()
  83│ 
  84│ 		ctx, stop := signal.NotifyContext(ctx, os.Interrupt)
  85│ 		defer stop()
  86│ 
  87│ 		<-ctx.Done()
  88│ 
  89│ 		logger.Println("Shutdown starting")
  90│ 		defer logger.Println("Shutdown complete")
  91│ 
  92│ 		if err := s.Shutdown(context.Background()); err != nil {
  93│ 			logger.Printf("Error during shutdown: %s\n", err)
  94│ 		}
  95│ 	}
  96│ */
  97│ package gemini
────╯

· · ·

info@source.community