protocol

Documentation

Overview

Package protocol defines the types necessary for unmarshalling a protocol-specification XML file.

Index

• type Arg
• type Description
• type Entry
  • func (e Entry) Int() (int, error)
• type Enum
• type Interface
• type Op
• type Protocol

Types

type Arg

type Arg struct {
	Name    string `xml:"name,attr"`
	Summary string `xml:"summary,attr"`

	Type      string `xml:"type,attr"`
	AllowNull bool   `xml:"allow-null,attr"`
	Interface string `xml:"interface,attr"`
	Version   int    `xml:"version,attr"`
	Enum      string `xml:"enum,attr"`
}

type Description

type Description struct {
	Summary string `xml:"summary,attr"`
	Full    string `xml:",chardata"`
}

type Entry

type Entry struct {
	Name    string `xml:"name,attr"`
	Summary string `xml:"summary,attr"`
	Value   string `xml:"value,attr"`
}

func (Entry) Int

func (e Entry) Int() (int, error)

type Enum

type Enum struct {
	Name        string      `xml:"name,attr"`
	Description Description `xml:"description"`

	Entries []Entry `xml:"entry"`
}

type Interface

type Interface struct {
	Name        string      `xml:"name,attr"`
	Version     int         `xml:"version,attr"`
	Description Description `xml:"description"`

	Requests []Op   `xml:"request"`
	Events   []Op   `xml:"event"`
	Enums    []Enum `xml:"enum"`
}

type Op

type Op struct {
	Name        string      `xml:"name,attr"`
	Description Description `xml:"description"`

	Args []Arg `xml:"arg"`
}

type Protocol

type Protocol struct {
	Name      string `xml:"name,attr"`
	Copyright string `xml:"copyright"`

	Interfaces []Interface `xml:"interface"`
}