streaming

Documentation

Index

• type Processor
  • func New(db db.DB, oauthServer oauth.Server) Processor

Types

type Processor

type Processor interface {
	// AuthorizeStreamingRequest returns an oauth2 token info in response to an access token query from the streaming API
	AuthorizeStreamingRequest(ctx context.Context, accessToken string) (*gtsmodel.Account, gtserror.WithCode)
	// OpenStreamForAccount returns a new Stream for the given account, which will contain a channel for passing messages back to the caller.
	OpenStreamForAccount(ctx context.Context, account *gtsmodel.Account, timeline string) (*stream.Stream, gtserror.WithCode)
	// StreamUpdateToAccount streams the given update to any open, appropriate streams belonging to the given account.
	StreamUpdateToAccount(s *apimodel.Status, account *gtsmodel.Account, timeline string) error
	// StreamNotificationToAccount streams the given notification to any open, appropriate streams belonging to the given account.
	StreamNotificationToAccount(n *apimodel.Notification, account *gtsmodel.Account) error
	// StreamDelete streams the delete of the given statusID to *ALL* open streams.
	StreamDelete(statusID string) error
}

Processor wraps a bunch of functions for processing streaming.

func New

func New(db db.DB, oauthServer oauth.Server) Processor

New returns a new status processor.