notify

Documentation

Index

• type Message
• type Notification
  • func NewAppearanceNotification(meta *types.MetaData, appearances []NotificationPayloadAppearance) *Notification[[]NotificationPayloadAppearance]
  • func NewChunkWrittenNotification(meta *types.MetaData, chunk string) *Notification[string]
  • func NewStageUpdatedNotification(meta *types.MetaData, chunkRange string) *Notification[string]
• type NotificationPayload
• type NotificationPayloadAppearance
  • func (n *NotificationPayloadAppearance) FromString(s string) (err error)
• type NotificationPayloadChunkWritten

Types

type Message

type Message string

const (
	MessageChunkWritten Message = "chunkWritten"
	MessageStageUpdated Message = "stageUpdated"
	MessageAppearance   Message = "appearance"
)

type Notification

type Notification[T NotificationPayload] struct {
	Msg     Message         `json:"msg"`
	Meta    *types.MetaData `json:"meta"`
	Payload T               `json:"payload"`
}

func NewAppearanceNotification

func NewAppearanceNotification(meta *types.MetaData, appearances []NotificationPayloadAppearance) *Notification[[]NotificationPayloadAppearance]

func NewChunkWrittenNotification

func NewChunkWrittenNotification(meta *types.MetaData, chunk string) *Notification[string]

func NewStageUpdatedNotification

func NewStageUpdatedNotification(meta *types.MetaData, chunkRange string) *Notification[string]

type NotificationPayload

type NotificationPayload interface {
	[]NotificationPayloadAppearance |
		[]NotificationPayloadChunkWritten |
		NotificationPayloadChunkWritten |
		string
}

type NotificationPayloadAppearance

type NotificationPayloadAppearance struct {
	Address string `json:"address"`
	// We use string for block number to ensure it's never
	// too big
	BlockNumber      string `json:"blockNumber"`
	TransactionIndex uint32 `json:"txid"`
}

func (*NotificationPayloadAppearance) FromString

func (n *NotificationPayloadAppearance) FromString(s string) (err error)

type NotificationPayloadChunkWritten

type NotificationPayloadChunkWritten struct {
	Cid    string `json:"cid"`
	Range  string `json:"range"`
	Author string `json:"author"`
}