sashakoshka/go-gemini
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of go-gemini
33 Commits 1 Branch 31 Tags 600 KiB
Go 100%
53d84882ea
Go to file
adnano 53d84882ea Implement configurable Client
2020-09-25 19:53:50 -04:00
examples Implement configurable Client 2020-09-25 19:53:50 -04:00
client.go Implement configurable Client 2020-09-25 19:53:50 -04:00
gemini_test.go Add test 2020-09-25 11:27:26 -04:00
gemini.go Reorganize 2020-09-25 19:09:49 -04:00
go.mod Initial commit 2020-09-21 15:49:09 -04:00
LICENSE Add LICENSE 2020-09-21 15:55:27 -04:00
README.md Implement configurable Client 2020-09-25 19:53:50 -04:00
server.go Reorganize 2020-09-25 19:09:49 -04:00
tofu.go Reorganize 2020-09-25 19:09:49 -04:00

README.md

go-gemini

GoDoc

go-gemini implements the Gemini protocol in Go.

It aims to provide an API similar to that of net/http to make it easy to develop Gemini clients and servers.

Examples

See examples/client and examples/server for an example client and server.

To run the examples:

go run -tags=example ./examples/server

Overview

A quick overview of the Gemini protocol:

  1. Client opens connection
  2. Server accepts connection
  3. Client and server complete a TLS handshake
  4. Client validates server certificate
  5. Client sends request
  6. Server sends response header
  7. Server sends response body (only for successful responses)
  8. Server closes connection
  9. Client handles response

The way this is implemented in this package is like so:

  1. Client makes a request with NewRequest. The client then sends the request with Send(*Request) (*Response, error).
  2. Server recieves the request and constructs a response. The server calls the Serve(*ResponseWriter, *Request) method on the Handler field. The handler writes the response. The server then closes the connection.
  3. Client recieves the response as a *Response. The client then handles the response.