httpfstream provides HTTP handlers for simultaneous streaming uploads and downloads of files, as well as persistence and a standalone server.
It allows a writer to APPEND data to a resource via a WebSocket and multiple
readers to FOLLOW updates to the resource using WebSockets.
Only one simultaneous appender is allowed for each resource. If there are no appenders at an existing resource, the server returns the full data in an HTTP 200 (bypassing WebSockets) to a follower. If the resource has never been written to, the server responds to a follower with HTTP 404.
go get github.com/sourcegraph/httpfstreamhttpfstream supports 2 modes of usage: as a standalone server or as a Go library.
The command httpfstream-server launches a server that allows clients to APPEND
and FOLLOW arbitrary file paths. Run with -h for more information.
For example, first install the commands:
$ go get github.com/sourcegraph/httpfstream/cmd/...Then run the server with:
$ httpfstream-server -root=/tmp/httpfstream -http=:8080Then launch a follower on /foo.txt:
$ httpfstream-follow -v http://localhost:8080/foo.txt
# keep this terminal window openAnd start appending to /foo.txt in a separate terminal:
$ httpfstream-append -v http://localhost:8080/foo.txt
# start typing:
foo
bar
baz
# now exit: ctrl-CNotice that the httpfstream-follow window echoes what you type into the
appender window. Once you close the appender, the follower quits as well.
The function httpfstream.New(root string)
takes the root file storage path as a parameter and returns an
http.Handler
that lets clients APPEND and FOLLOW to paths it handles.
The file cmd/httpfstream-server/server.go contains a full example, summarized here:
package main
import (
"github.com/sourcegraph/httpfstream"
"log"
"net/http"
"os"
)
func main() {
h := httpfstream.New("/tmp/httpfstream")
h.Log = log.New(os.Stderr, "", 0)
http.Handle("/", h)
err := http.ListenAndServe(":8080", nil)
if err != nil {
log.Fatalf("ListenAndServe: %s", err)
}
}Clients can append data to a resource using either httpfstream.Append(u *url.URL, r io.Reader) error
(if they already have an io.Reader) or httpfstream.OpenAppend(u *url.URL) (io.WriteCloser, error).
Click on the function names (linked above) to see full docs and usage examples on Sourcegraph.
Clients can follow a resource's data using httpfstream.Follow(u *url.URL) (io.ReadCloser, error).
Click on the function names (linked above) to see full docs and usage examples on Sourcegraph.
Patches and bug reports welcomed! Report issues and submit pull requests using GitHub.