introspection

Documentation

Index

• Variables
• type ChooserStatus
• type DispatcherStatus
• type InboundStatus
• type IntrospectableChooser
• type IntrospectableInbound
• type IntrospectableOutbound
• type OutboundStatus
• type PackageVersion
• type PeerStatus
• type Procedure
  • func IntrospectProcedures(routerProcs []transport.Procedure) []Procedure

Variables

var OutboundStatusNotSupported = OutboundStatus{}

OutboundStatusNotSupported is returned when not valid OutboundStatus can be produced.

Types

type ChooserStatus

type ChooserStatus struct {
	Name  string       `json:"name"`
	State string       `json:"state"`
	Peers []PeerStatus `json:"peers"`
}

ChooserStatus is a collection of basic chooser info.

type DispatcherStatus

type DispatcherStatus struct {
	Name            string           `json:"name"`
	ID              string           `json:"id"`
	Procedures      []Procedure      `json:"procedures"`
	Inbounds        []InboundStatus  `json:"inbounds"`
	Outbounds       []OutboundStatus `json:"outbounds"`
	PackageVersions []PackageVersion `json:"packageVersions"`
}

DispatcherStatus represent detailed introspection information about a dispatcher.

type InboundStatus

type InboundStatus struct {
	Transport string `json:"transport"`
	Endpoint  string `json:"endpoint"`
	State     string `json:"state"`
}

InboundStatus is a collection of basics info about an Inbound.

type IntrospectableChooser

type IntrospectableChooser interface {
	Introspect() ChooserStatus
}

IntrospectableChooser extends the Chooser interfaces.

type IntrospectableInbound

type IntrospectableInbound interface {
	Introspect() InboundStatus
}

IntrospectableInbound extends the Inbound interface.

type IntrospectableOutbound

type IntrospectableOutbound interface {
	Introspect() OutboundStatus
}

IntrospectableOutbound extends the Outbound interface.

type OutboundStatus

type OutboundStatus struct {
	Transport   string        `json:"transport"`
	RPCType     string        `json:"rpctype"`
	Endpoint    string        `json:"endpoint"`
	State       string        `json:"state"`
	Chooser     ChooserStatus `json:"chooser"`
	Service     string        `json:"service"`
	OutboundKey string        `json:"outboundkey"`
}

OutboundStatus is a collection of basics info about an Outbound.

type PackageVersion

type PackageVersion struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

PackageVersion represent a package and its version.

type PeerStatus

type PeerStatus struct {
	Identifier string `json:"identifier"`
	State      string `json:"state"`
}

PeerStatus is a collection of basic peers info.

type Procedure

type Procedure struct {
	Name      string `json:"name"`
	Encoding  string `json:"encoding"`
	Signature string `json:"signature"`
	RPCType   string `json:"rpcType"`
}

Procedure represent a registered procedure on a dispatcher.

func IntrospectProcedures

func IntrospectProcedures(routerProcs []transport.Procedure) []Procedure

IntrospectProcedures is a convenience function that translate a slice of transport.Procedure to a slice of introspection.Procedure. This output is used in debug and yarpcmeta.