Package gopher

import "bitbucket.org/antizealot1337/gopher"

Overview
Index

Overview

Index

func ListenAndServe(addr string, handler Handler) error
type Handler
type HandlerFunc
func (h HandlerFunc) Serve(w *ResponseWriter, r *Request)
type Item
type ItemType
func CannonicalGuessItemType(name string) ItemType
func GuessItemType(name string) ItemType
type Menu
type Muxer
func NewMuxer() *Muxer
func (m *Muxer) Handle(path string, handler Handler)
func (m *Muxer) Serve(w *ResponseWriter, r *Request)
type Request
type ResponseWriter
func (w *ResponseWriter) Done() (err error)
func (w *ResponseWriter) RawItem(kind byte, disp, sel, hname string, port int) (err error)
func (w *ResponseWriter) Write(data []byte) (int, error)
func (w *ResponseWriter) WriteBin(disp, sel, hname string, port int) error
func (w *ResponseWriter) WriteError(msg string) error
func (w *ResponseWriter) WriteInfo(msg string) error
func (w *ResponseWriter) WriteItem(i Item) error
func (w *ResponseWriter) WriteLink(disp, sel, hname string, port int) error
func (w *ResponseWriter) WriteMenu(m Menu) (err error)
func (w *ResponseWriter) WriteText(disp, sel, hname string, port int) error
type Server
func (s *Server) ListenAndServe() error
func (s *Server) Serve(listener net.Listener) error

Package files

menu.go muxer.go request.go responsewriter.go server.go

func ListenAndServe

func ListenAndServe(addr string, handler Handler) error

ListenAndServe is a conveince methods to quickly setup a Server and start handling requests.

type Handler

Handler is something that can handle a client connection.

type Handler interface {
    Serve(writer *ResponseWriter, request *Request)
} //interface

type HandlerFunc

HandlerFunc is a function that implements Handler.

type HandlerFunc func(*ResponseWriter, *Request)

func (HandlerFunc) Serve

func (h HandlerFunc) Serve(w *ResponseWriter, r *Request)

Serve the connection by using the HandlerFunc.

type Item

Item represents an item in a gopher menu.

type Item struct {
    Type     ItemType
    Display  string
    Selector string
    Hostname string
    Port     int
} //func

type ItemType

ItemType represents a menu item type for the Gopher protocol.

type ItemType byte

Canonical types

const (
    ItemText           ItemType = '0'
    ItemSubMenu        ItemType = '1'
    ItemCCSONameserver ItemType = '2'
    ItemError          ItemType = '3'
    ItemBinHexEnc      ItemType = '4'
    ItemDOSFile        ItemType = '5'
    ItemUuencoded      ItemType = '6'
    ItemFullTextSearch ItemType = '7'
    ItemTelnet         ItemType = '8'
    ItemBinary         ItemType = '9'
    ItemMirror         ItemType = '+'
    ItemGIF            ItemType = 'g'
    ItemImage          ItemType = 'I'
)

Non-canonical types

const (
    ItemHTML    ItemType = 'h'
    ItemInfoMsg ItemType = 'i'
    ItemSound   ItemType = 's'
)

func CannonicalGuessItemType

func CannonicalGuessItemType(name string) ItemType

CannonicalGuessItemType will attempt to deduce the ItemType by looking at the provided name. It follows the same rules as GuessItemType but will return ItemBinary for HTML and sound/audio files.

func GuessItemType

func GuessItemType(name string) ItemType

GuessItemType will attempt to deduce the ItemType by looking at the provided filename. Non-canonical types are included. For Canonical only types use CannonicalGuessItemType. The rules are as follows:

If the file ends in .txt it is assumed to be a text file. If it ends in .gif it is a GIF. Files ending in .png, .jp(e)?g, ,.svg, .tiff are assumed to be image files. If the file ends in .html it is assumed to be a HTML file. Files ending with .wav, .mp3, .aac, .flac, .ogg are assumed to be sound files.

Menu is a slice of Items.

type Menu []Item

type Muxer

Muxer handles looks at the request and determines which Handler to call.

type Muxer struct {
    // contains filtered or unexported fields
} //func

func NewMuxer

func NewMuxer() *Muxer

NewMuxer returns a new Muxer.

func (*Muxer) Handle

func (m *Muxer) Handle(path string, handler Handler)

Handle adds a new Handler for the path to the Muxer. If a previous Handler existed for the path it is forgotten.

func (*Muxer) Serve

func (m *Muxer) Serve(w *ResponseWriter, r *Request)

Serve the client with some Handler.

type Request

Request contains data about a gopher client request.

type Request struct {
    Path string
    Addr net.Addr
} //struct

type ResponseWriter

ResponseWriter provides functionality to write to a Gopher client. It provides somme convienence methods for writing "menu items".

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

func (*ResponseWriter) Done

func (w *ResponseWriter) Done() (err error)

Done will send a full stop (".") on a line all to itself. A "good" gopher server will write a full stop before disconnecting the client. However, most clients seem to be able to deal with a missing full-stop. Thus calling Done is probably optional (but recommended).

func (*ResponseWriter) RawItem

func (w *ResponseWriter) RawItem(kind byte, disp, sel, hname string, port int) (err error)

RawItem is a method that does a raw write of an item withough any checking. Use other methods for specific (known) types.

func (*ResponseWriter) Write

func (w *ResponseWriter) Write(data []byte) (int, error)

Write data to the ResponseWriter.

func (*ResponseWriter) WriteBin

func (w *ResponseWriter) WriteBin(disp, sel, hname string, port int) error

WriteBin writes a binary link item.

func (*ResponseWriter) WriteError

func (w *ResponseWriter) WriteError(msg string) error

WriteError writes an error line.

func (*ResponseWriter) WriteInfo

func (w *ResponseWriter) WriteInfo(msg string) error

WriteInfo writes an info line.

func (*ResponseWriter) WriteItem

func (w *ResponseWriter) WriteItem(i Item) error

WriteItem writes an Item from a Menu.

func (*ResponseWriter) WriteLink

func (w *ResponseWriter) WriteLink(disp, sel, hname string, port int) error

WriteLink writes a link to gopher submenu.

func (*ResponseWriter) WriteMenu

func (w *ResponseWriter) WriteMenu(m Menu) (err error)

WriteMenu writes a Menu.

func (*ResponseWriter) WriteText

func (w *ResponseWriter) WriteText(disp, sel, hname string, port int) error

WriteText writes a text link item.

type Server

Server takes care of client connections.

type Server struct {
    Addr    string
    Handler Handler
} //struct

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe starts the server listening and handling connections.

func (*Server) Serve

func (s *Server) Serve(listener net.Listener) error

Serve starts the server handling connections/requests with the provided listener.

bitbucket.org/antizealot1337/gopher

Gopher

Status

Why?

Usage

License