summaryrefslogtreecommitdiff
path: root/vendor/github.com/superseriousbusiness/activity/pub/database.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/superseriousbusiness/activity/pub/database.go')
-rw-r--r--vendor/github.com/superseriousbusiness/activity/pub/database.go18
1 files changed, 14 insertions, 4 deletions
diff --git a/vendor/github.com/superseriousbusiness/activity/pub/database.go b/vendor/github.com/superseriousbusiness/activity/pub/database.go
index 1abf98b0d..8d3bbd465 100644
--- a/vendor/github.com/superseriousbusiness/activity/pub/database.go
+++ b/vendor/github.com/superseriousbusiness/activity/pub/database.go
@@ -59,13 +59,23 @@ type Database interface {
//
// The library makes this call only after acquiring a lock first.
OutboxForInbox(c context.Context, inboxIRI *url.URL) (outboxIRI *url.URL, err error)
- // InboxForActor fetches the inbox corresponding to the given actorIRI.
+ // InboxesForIRI fetches inboxes corresponding to the given iri.
+ // This allows your server to skip remote dereferencing of iris
+ // in order to speed up message delivery, if desired.
//
- // It is acceptable to just return nil for the inboxIRI. In this case, the library will
- // attempt to resolve the inbox of the actor by remote dereferencing instead.
+ // It is acceptable to just return nil or an empty slice for the inboxIRIs,
+ // if you don't know the inbox iri, or you don't wish to use this feature.
+ // In this case, the library will attempt to resolve inboxes of the iri
+ // by remote dereferencing instead.
+ //
+ // If the input iri is the iri of an Actor, then the inbox for the actor
+ // should be returned as a single-entry slice.
+ //
+ // If the input iri is a Collection (such as a Collection of followers),
+ // then each follower inbox IRI should be returned in the inboxIRIs slice.
//
// The library makes this call only after acquiring a lock first.
- InboxForActor(c context.Context, actorIRI *url.URL) (inboxIRI *url.URL, err error)
+ InboxesForIRI(c context.Context, iri *url.URL) (inboxIRIs []*url.URL, err error)
// Exists returns true if the database has an entry for the specified
// id. It may not be owned by this application instance.
//