nex

Documentation

Overview

Package nex provides nex station (server) and client functionality.

For more information about nex, see https://nightfall.city/nex/info/.

Index

• type Response
  • func Request(ctx context.Context, rawURL string) (*Response, error)
  • func (r *Response) Read(b []byte) (int, error)
• type Station
  • func (station *Station) Serve(rw io.ReadWriteCloser) error
  • func (station *Station) ServeAt(tm time.Time, rw io.ReadWriteCloser) error

Types

type Response

type Response struct {
	Raw  io.Reader
	Conn net.Conn
}

A Response represents a response from a nex station. It implements the io.Reader interface.

func Request

func Request(ctx context.Context, rawURL string) (*Response, error)

Request makes a nex request to rawURL.

func (*Response) Read

func (r *Response) Read(b []byte) (int, error)

Read reads up to len(b) bytes into b.

type Station

type Station struct {
	FS        fs.FS
	Nocturnal bool
	Latitude  float64
}

A Station serves content from FS. Only open at night if Nocturnal is true. Uses Latitude to roughly estimate dawn and dusk.

func (*Station) Serve

func (station *Station) Serve(rw io.ReadWriteCloser) error

Reads a nex request from rw and tries to serve the matching file.

func (*Station) ServeAt

func (station *Station) ServeAt(tm time.Time, rw io.ReadWriteCloser) error

Tries to serve a request at the specific time tm. Useful for testing Nocturnal stations.