ostatus

README

go-ostatus

An OStatus library written in Go. It can be used to build custom OStatus instances (e.g. a Twitter instance).

The protocol suite includes:

• Atom
• Atom Activity Streams
• Atom Threading Extensions
• PubSubHubbub
• XRD
• Web Host Metadata
• WebFinger
• LRDD
• Web Linking
• Salmon (spec)
• Portable Contacts

License

MIT

Documentation

Overview

Package ostatus implements the OStatus protocol suite.

Index

• Constants
• Variables
• type Backend
• type Handler
  • func NewHandler(be Backend, hostmetaResource *xrd.Resource) *Handler

Constants

const RelSubscribe = "http://ostatus.org/schema/1.0/subscribe"

RelSubscribe is the subscribe relation.

Variables

var (
	HubPath    = "/hub"
	SalmonPath = "/salmon"
)

Default endpoints.

Types

type Backend

type Backend interface {
	webfinger.Backend
	pubsubhubbub.Backend
	salmon.Backend

	// Feed fetches a feed about a topic.
	Feed(topic string) (*activitystream.Feed, error)
}

A Backend is used to create OStatus instances.

type Handler

type Handler struct {
	http.Handler

	Publisher *pubsubhubbub.Publisher
}

Handler handles OStatus requests.

func NewHandler

func NewHandler(be Backend, hostmetaResource *xrd.Resource) *Handler

NewHandler creates a new OStatus endpoint.