receipts

Documentation

Overview

Package receipts implements XEP-0184: Message Delivery Receipts.

Index

• Constants
• Variables
• func Handle(h *Handler) mux.Option
• func Request(r xml.TokenReader) xml.TokenReader
• type Handler
  • func (h *Handler) ForFeatures(node string, f func(info.Feature) error) error
  • func (h *Handler) HandleMessage(msg stanza.Message, t xmlstream.TokenReadEncoder) error
  • func (h *Handler) SendMessage(ctx context.Context, s *xmpp.Session, r xml.TokenReader) error
  • func (h *Handler) SendMessageElement(ctx context.Context, s *xmpp.Session, payload xml.TokenReader, ...) error
• type Requested
  • func (r Requested) MarshalXML(e *xml.Encoder, _ xml.StartElement) error
  • func (r Requested) TokenReader() xml.TokenReader
  • func (r *Requested) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
  • func (r Requested) WriteXML(w xmlstream.TokenWriter) (int, error)

Constants

const (
	// NS is the XML namespace used by message delivery receipts.
	// It is provided as a convenience.
	NS = "urn:xmpp:receipts"
)

Variables

var (
	Feature = info.Feature{Var: NS}
)

A list of service discovery features that are supported by this package.

Functions

func Handle

func Handle(h *Handler) mux.Option

Handle returns an option that registers a Handler for message receipts.

func Request

func Request(r xml.TokenReader) xml.TokenReader

Request is an xmlstream.Transformer that inserts a request for a read receipt into any message read through r that is not itself a receipt. It is provided to allow easily requesting read receipts asynchronously. To send a message and block waiting on a read receipt, see the methods on Handler.

Types

type Handler

type Handler struct {
	Unhandled func(string)
	// contains filtered or unexported fields
}

Handler listens for incoming message receipts and matches them to outgoing messages sent with SendMessage or SendMessageElement. If Unhandled is set it is called for every receipt that cannot be matched to a message sent through the handler.

func (*Handler) ForFeatures

func (h *Handler) ForFeatures(node string, f func(info.Feature) error) error

ForFeatures implements info.FeatureIter.

func (*Handler) HandleMessage

func (h *Handler) HandleMessage(msg stanza.Message, t xmlstream.TokenReadEncoder) error

HandleMessage implements mux.MessageHandler and responds to requests and responses for message delivery receipts.

func (*Handler) SendMessage

func (h *Handler) SendMessage(ctx context.Context, s *xmpp.Session, r xml.TokenReader) error

SendMessage transmits the first element read from the provided token reader over the session if the element is a message stanza, otherwise it returns an error. SendMessage adds a request for a message receipt and an ID if one does not already exist.

If the context is closed before the message delivery receipt is received, SendMessage immediately returns the context error. Any response received at a later time will no be associated with the original request, but can still be handled by the Handler. If the returned error is nil, receipt of the message was successfully acknowledged.

SendMessage is safe for concurrent use by multiple goroutines.

func (*Handler) SendMessageElement

func (h *Handler) SendMessageElement(ctx context.Context, s *xmpp.Session, payload xml.TokenReader, msg stanza.Message) error

SendMessageElement is like SendMessage except that it wraps the payload in the message element derived from msg. For more information, see SendMessage.

SendMessageElement is safe for concurrent use by multiple goroutines.

type Requested

type Requested struct {
	XMLName xml.Name `xml:"urn:xmpp:receipts request"`
	Value   bool
}

Requested is a type that can be added to messages to request a read receipt. When unmarshaled or marshaled its value indicates whether it was or will be present in the message.

This type is used to manually include a request in a message struct. To send a message and wait for the receipt see the methods on Handler.

func (Requested) MarshalXML

func (r Requested) MarshalXML(e *xml.Encoder, _ xml.StartElement) error

MarshalXML implements xml.Marshaler.

func (Requested) TokenReader

func (r Requested) TokenReader() xml.TokenReader

TokenReader implements xmlstream.Marshaler.

func (*Requested) UnmarshalXML

func (r *Requested) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements xml.Unmarshaler.

func (Requested) WriteXML

func (r Requested) WriteXML(w xmlstream.TokenWriter) (int, error)

WriteXML implements xmlstream.WriterTo.