xmppparser

Documentation

Index

• Constants
• Variables
• type Parser
  • func New(reader io.Reader, mode ParsingMode, maxStanzaSize int) *Parser
  • func (p *Parser) Parse() (stravaganza.Element, error)
• type ParsingMode

Constants

const (
	// DefaultMode treats incoming elements as provided from raw byte reader.
	DefaultMode = ParsingMode(iota)

	// SocketStream treats incoming elements as provided from a socket transport.
	SocketStream
)

Variables

var ErrNoElement = errors.New("parser: no elements")

ErrNoElement will be returned by Parse when no elements are available to be parsed in the reader buffer stream.

var ErrStreamClosedByPeer = errors.New("parser: stream closed by peer")

ErrStreamClosedByPeer will be returned by Parse when stream closed element is parsed.

var ErrTooLargeStanza = errors.New("parser: too large stanza")

ErrTooLargeStanza will be returned Parse when the size of the incoming stanza is too large.

Types

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser parses arbitrary XML input and builds an array with the structure of all tag and data elements.

func New

func New(reader io.Reader, mode ParsingMode, maxStanzaSize int) *Parser

New creates an empty Parser instance.

func (*Parser) Parse

func (p *Parser) Parse() (stravaganza.Element, error)

Parse parses next available XML element from reader.

type ParsingMode

type ParsingMode int

ParsingMode defines the way in which special parsed element should be considered or not according to the reader nature.