service

Documentation

Index

• type Config
• type PubSub
• type Service
  • func New(cfg *Config, activityStore store.Store, t httpTransport, ...) (*Service, error)
  • func (s *Service) InboxHTTPHandler() common.HTTPHandler
  • func (s *Service) InboxHandler() spi.InboxHandler
  • func (s *Service) Outbox() spi.Outbox
  • func (s *Service) Subscribe() <-chan *vocab.ActivityType

Types

type Config

type Config struct {
	ServiceEndpoint           string
	ServiceIRI                *url.URL
	ActivityHandlerBufferSize int
	VerifyActorInSignature    bool

	// MaxWitnessDelay is the maximum delay that the witnessed transaction becomes included into the ledger.
	MaxWitnessDelay time.Duration

	IRICacheSize             int
	IRICacheExpiration       time.Duration
	OutboxSubscriberPoolSize int
}

Config holds the configuration parameters for an ActivityPub service.

type PubSub

type PubSub interface {
	Subscribe(ctx context.Context, topic string) (<-chan *message.Message, error)
	SubscribeWithOpts(ctx context.Context, topic string, opts ...pubsub.Option) (<-chan *message.Message, error)
	Publish(topic string, messages ...*message.Message) error
	Close() error
}

PubSub defines the functions for a publisher/subscriber.

type Service

type Service struct {
	*lifecycle.Lifecycle
	// contains filtered or unexported fields
}

Service implements an ActivityPub service which has an inbox, outbox, and handlers for the various ActivityPub activities.

func New

func New(cfg *Config, activityStore store.Store, t httpTransport, sigVerifier signatureVerifier,
	pubSub PubSub, activityPubClient activityPubClient, resourceResolver resourceResolver,
	tm authTokenManager, m metricsProvider, handlerOpts ...spi.HandlerOpt) (*Service, error)

New returns a new ActivityPub service.

func (*Service) InboxHTTPHandler

func (s *Service) InboxHTTPHandler() common.HTTPHandler

InboxHTTPHandler returns the HTTP handler for the inbox which is invoked by the HTTP server. This handler must be registered with an HTTP server.

func (*Service) InboxHandler

func (s *Service) InboxHandler() spi.InboxHandler

InboxHandler returns the handler for inbox activities.

func (*Service) Outbox

func (s *Service) Outbox() spi.Outbox

Outbox returns the outbox, which allows clients to post activities.

func (*Service) Subscribe

func (s *Service) Subscribe() <-chan *vocab.ActivityType

Subscribe allows a client to receive published activities.