standards

Documentation

Overview

Package standards provides international protocol standard integration.

Index

• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Describe() string
  • func (r *Registry) FindByOrg(org StandardOrg) []Standard
  • func (r *Registry) FindByProtocol(protocol string) []Standard
• type Standard
• type StandardOrg

Types

type Registry

type Registry struct {
	Standards []Standard
}

Registry holds known standards.

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a new standards registry.

func (*Registry) Describe

func (r *Registry) Describe() string

Describe returns a text listing.

func (*Registry) FindByOrg

func (r *Registry) FindByOrg(org StandardOrg) []Standard

FindByOrg finds standards by organization.

func (*Registry) FindByProtocol

func (r *Registry) FindByProtocol(protocol string) []Standard

FindByProtocol finds standards for a protocol.

type Standard

type Standard struct {
	ID       string      `json:"id"`
	Title    string      `json:"title"`
	Org      StandardOrg `json:"org"`
	Version  string      `json:"version"`
	Protocol string      `json:"protocol"`
	URL      string      `json:"url"`
}

Standard represents a protocol standard reference.

type StandardOrg

type StandardOrg string

StandardOrg represents a standards organization.

const (
	OrgIETF StandardOrg = "IETF"
	OrgIEEE StandardOrg = "IEEE"
	OrgITU  StandardOrg = "ITU-T"
	Org3GPP StandardOrg = "3GPP"
)