messages

Documentation

Index

• func ClientMsgIndices() []structr.IndexConfig
• func FederatorMsgIndices() []structr.IndexConfig
• type FromClientAPI
  • func (msg *FromClientAPI) Deserialize(data []byte) error
  • func (msg *FromClientAPI) Serialize() ([]byte, error)
• type FromFediAPI
  • func (msg *FromFediAPI) Deserialize(data []byte) error
  • func (msg *FromFediAPI) Serialize() ([]byte, error)

Functions

func ClientMsgIndices

func ClientMsgIndices() []structr.IndexConfig

ClientMsgIndices defines queue indices this message type should be accessible / stored under.

func FederatorMsgIndices

func FederatorMsgIndices() []structr.IndexConfig

FederatorMsgIndices defines queue indices this message type should be accessible / stored under.

Types

type FromClientAPI

type FromClientAPI struct {

	// APObjectType ...
	APObjectType string

	// APActivityType ...
	APActivityType string

	// Optional GTS database model
	// of the Activity / Object.
	GTSModel interface{}

	// Targeted object URI.
	TargetURI string

	// Origin is the account that
	// this message originated from.
	Origin *gtsmodel.Account

	// Target is the account that
	// this message is targeting.
	Target *gtsmodel.Account
}

FromClientAPI wraps a message that travels from the client API into the processor.

func (*FromClientAPI) Deserialize

func (msg *FromClientAPI) Deserialize(data []byte) error

Deserialize will attempt to deserialize a blob of task data, which will involve unflattening previously serialized data and leave some message structures as placeholders to holding IDs.

func (*FromClientAPI) Serialize

func (msg *FromClientAPI) Serialize() ([]byte, error)

Serialize will serialize the worker data as data blob for storage, note that this will flatten some of the data e.g. only account IDs.

type FromFediAPI

type FromFediAPI struct {

	// APObjectType ...
	APObjectType string

	// APActivityType ...
	APActivityType string

	// Optional ActivityPub ID (IRI)
	// and / or model of Activity / Object.
	APIRI    *url.URL
	APObject interface{}

	// Optional GTS database model
	// of the Activity / Object.
	GTSModel interface{}

	// Targeted object URI.
	TargetURI string

	// Remote account that posted
	// this Activity to the inbox.
	Requesting *gtsmodel.Account

	// Local account which owns the inbox
	// that this Activity was posted to.
	Receiving *gtsmodel.Account
}

FromFediAPI wraps a message that travels from the federating API into the processor.

func (*FromFediAPI) Deserialize

func (msg *FromFediAPI) Deserialize(data []byte) error

Deserialize will attempt to deserialize a blob of task data, which will involve unflattening previously serialized data and leave some message structures as placeholders to holding IDs.

func (*FromFediAPI) Serialize

func (msg *FromFediAPI) Serialize() ([]byte, error)

Serialize will serialize the worker data as data blob for storage, note that this will flatten some of the data e.g. only account IDs.