mgmt

Documentation

Index

• func MakeStatusDataset(name *ndn.Name, version uint64, dataset []byte) []*ndn.Data
• type ChannelStatus
  • func MakeChannelStatus(localURI *ndn.URI) *ChannelStatus
  • func (c *ChannelStatus) Encode() (*tlv.Block, error)
• type ControlParameters
  • func DecodeControlParameters(wire *tlv.Block) (*ControlParameters, error)
  • func MakeControlParameters() *ControlParameters
  • func (c *ControlParameters) Encode() (*tlv.Block, error)
• type ControlResponse
  • func DecodeControlResponse(wire *tlv.Block) (*ControlResponse, error)
  • func MakeControlResponse(statusCode uint64, statusText string, body *tlv.Block) *ControlResponse
  • func (c *ControlResponse) Encode() (*tlv.Block, error)
• type CsFlag
• type CsStatus
  • func (s *CsStatus) Encode() (*tlv.Block, error)
• type FaceQueryFilter
  • func DecodeFaceQueryFilter(wire *tlv.Block) (*FaceQueryFilter, error)
  • func DecodeFaceQueryFilterFromEncoded(wire []byte) (*FaceQueryFilter, error)
  • func MakeFaceQueryFilter() *FaceQueryFilter
  • func (f *FaceQueryFilter) Encode() (*tlv.Block, error)
• type FaceStatus
  • func MakeFaceStatus() *FaceStatus
  • func (f *FaceStatus) Encode() (*tlv.Block, error)
• type FibEntry
  • func MakeFibEntry(name *ndn.Name) *FibEntry
  • func (f *FibEntry) Encode() (*tlv.Block, error)
• type GeneralStatus
  • func MakeGeneralStatus() *GeneralStatus
  • func (g *GeneralStatus) Encode() (*tlv.Block, error)
• type NextHopRecord
• type RibEntry
  • func MakeRibEntry(name *ndn.Name) *RibEntry
  • func (f *RibEntry) Encode() (*tlv.Block, error)
• type Route
• type StrategyChoice
  • func MakeStrategyChoice(name *ndn.Name, strategy *ndn.Name) *StrategyChoice
• type StrategyChoiceList
  • func MakeStrategyChoiceList() StrategyChoiceList
  • func (s *StrategyChoiceList) Encode() ([]*tlv.Block, error)

Functions

func MakeStatusDataset

func MakeStatusDataset(name *ndn.Name, version uint64, dataset []byte) []*ndn.Data

MakeStatusDataset creates a set of status dataset packets based upon the specified prefix, version, and dataset information.

Types

type ChannelStatus

type ChannelStatus struct {
	LocalURI ndn.URI
}

ChannelStatus contains status information about a channel.

func MakeChannelStatus

func MakeChannelStatus(localURI *ndn.URI) *ChannelStatus

MakeChannelStatus creates a ChannelStatus.

func (*ChannelStatus) Encode

func (c *ChannelStatus) Encode() (*tlv.Block, error)

Encode encodes a ChannelStatus.

type ControlParameters

type ControlParameters struct {
	Name                          *ndn.Name
	FaceID                        *uint64
	URI                           *ndn.URI
	LocalURI                      *ndn.URI
	Origin                        *uint64
	Cost                          *uint64
	Capacity                      *uint64
	Count                         *uint64
	BaseCongestionMarkingInterval *uint64
	DefaultCongestionThreshold    *uint64
	MTU                           *uint64
	Flags                         *uint64
	Mask                          *uint64
	Strategy                      *ndn.Name
	ExpirationPeriod              *uint64
	FacePersistency               *uint64
}

ControlParameters represents the parameters of a management command.

func DecodeControlParameters

func DecodeControlParameters(wire *tlv.Block) (*ControlParameters, error)

DecodeControlParameters decodes a ControlParameters from the wire.

func MakeControlParameters

func MakeControlParameters() *ControlParameters

MakeControlParameters creates an empty ControlParameters.

func (*ControlParameters) Encode

func (c *ControlParameters) Encode() (*tlv.Block, error)

Encode encodes a ControlParameters.

type ControlResponse

type ControlResponse struct {
	StatusCode uint64
	StatusText string
	Body       *tlv.Block
}

ControlResponse represents the response from a management command.

func DecodeControlResponse

func DecodeControlResponse(wire *tlv.Block) (*ControlResponse, error)

DecodeControlResponse decodes a ControlResponse from the wire.

func MakeControlResponse

func MakeControlResponse(statusCode uint64, statusText string, body *tlv.Block) *ControlResponse

MakeControlResponse creates a ControlResponse.

func (*ControlResponse) Encode

func (c *ControlResponse) Encode() (*tlv.Block, error)

Encode encodes a ControlResponse.

type CsFlag

type CsFlag int

CsFlag indicates a ContentStore status flag.

const (
	CsFlagEnableAdmit CsFlag = 1 << iota
	CsFlagEnableServe
)

type CsStatus

type CsStatus struct {
	Capacity   uint64
	Flags      CsFlag
	NCsEntries uint64
	NHits      uint64
	NMisses    uint64
}

CsStatus contains status information about the Content Store.

func (*CsStatus) Encode

func (s *CsStatus) Encode() (*tlv.Block, error)

Encode encodes a CsStatus.

type FaceQueryFilter

type FaceQueryFilter struct {
	FaceID          *uint64
	URIScheme       *string
	URI             *ndn.URI
	LocalURI        *ndn.URI
	FaceScope       *uint64
	FacePersistency *uint64
	LinkType        *uint64
}

FaceQueryFilter is a filter used to retrieve a subset of faces matching the filter.

func DecodeFaceQueryFilter

func DecodeFaceQueryFilter(wire *tlv.Block) (*FaceQueryFilter, error)

DecodeFaceQueryFilter decodes a FaceQueryFilter from the wire.

func DecodeFaceQueryFilterFromEncoded

func DecodeFaceQueryFilterFromEncoded(wire []byte) (*FaceQueryFilter, error)

DecodeFaceQueryFilterFromEncoded decodes a FaceQueryFilter from an encoded byte string.

func MakeFaceQueryFilter

func MakeFaceQueryFilter() *FaceQueryFilter

MakeFaceQueryFilter creates an empty FaceQueryFilter.

func (*FaceQueryFilter) Encode

func (f *FaceQueryFilter) Encode() (*tlv.Block, error)

Encode encodes a FaceQueryFilter.

type FaceStatus

type FaceStatus struct {
	FaceID                        uint64
	URI                           *ndn.URI
	LocalURI                      *ndn.URI
	ExpirationPeriod              *uint64
	FaceScope                     uint64
	FacePersistency               uint64
	LinkType                      uint64
	BaseCongestionMarkingInterval *uint64
	DefaultCongestionThreshold    *uint64
	MTU                           *uint64
	NInInterests                  uint64
	NInData                       uint64
	NInNacks                      uint64
	NOutInterests                 uint64
	NOutData                      uint64
	NOutNacks                     uint64
	NInBytes                      uint64
	NOutBytes                     uint64
	Flags                         uint64
}

FaceStatus contains status information about a face.

func MakeFaceStatus

func MakeFaceStatus() *FaceStatus

MakeFaceStatus creates an empty FaceStatus.

func (*FaceStatus) Encode

func (f *FaceStatus) Encode() (*tlv.Block, error)

Encode encodes a FaceStatus.

type FibEntry

type FibEntry struct {
	Name     ndn.Name
	Nexthops []NextHopRecord
}

FibEntry contains status information about a FIB entry.

func MakeFibEntry

func MakeFibEntry(name *ndn.Name) *FibEntry

MakeFibEntry creates an empty FibEntry.

func (*FibEntry) Encode

func (f *FibEntry) Encode() (*tlv.Block, error)

Encode encodes a FibEntry.

type GeneralStatus

type GeneralStatus struct {
	NfdVersion            string
	StartTimestamp        uint64
	CurrentTimestamp      uint64
	NNameTreeEntries      uint64
	NFibEntries           uint64
	NPitEntries           uint64
	NMeasurementEntries   uint64
	NCsEntries            uint64
	NInInterests          uint64
	NInData               uint64
	NInNacks              uint64
	NOutInterests         uint64
	NOutData              uint64
	NOutNacks             uint64
	NSatisfiedInterests   uint64
	NUnsatisfiedInterests uint64
}

GeneralStatus contains status information about the forwarder's overall status.

func MakeGeneralStatus

func MakeGeneralStatus() *GeneralStatus

MakeGeneralStatus creates an empty GeneralStatus.

func (*GeneralStatus) Encode

func (g *GeneralStatus) Encode() (*tlv.Block, error)

Encode encodes a GeneralStatus.

type NextHopRecord

type NextHopRecord struct {
	FaceID uint64
	Cost   uint64
}

NextHopRecord represents a next hop record in a FibEntry.

type RibEntry

type RibEntry struct {
	Name   ndn.Name
	Routes []Route
}

RibEntry contains status information about a RIB entry.

func MakeRibEntry

func MakeRibEntry(name *ndn.Name) *RibEntry

MakeRibEntry creates an empty RibEntry.

func (*RibEntry) Encode

func (f *RibEntry) Encode() (*tlv.Block, error)

Encode encodes a RibEntry.

type Route

type Route struct {
	FaceID           uint64
	Origin           uint64
	Cost             uint64
	Flags            uint64
	ExpirationPeriod *time.Duration
}

Route represents a route record in a RibEntry.

type StrategyChoice

type StrategyChoice struct {
	Name     *ndn.Name
	Strategy *ndn.Name
}

StrategyChoice contains status information about a Strategy Choice table entry.

func MakeStrategyChoice

func MakeStrategyChoice(name *ndn.Name, strategy *ndn.Name) *StrategyChoice

MakeStrategyChoice creates a StrategyChoice entry.

type StrategyChoiceList

type StrategyChoiceList []*StrategyChoice

StrategyChoiceList is a list of strategy choices.

func MakeStrategyChoiceList

func MakeStrategyChoiceList() StrategyChoiceList

MakeStrategyChoiceList creates an empty StrategyChoiceList.

func (*StrategyChoiceList) Encode

func (s *StrategyChoiceList) Encode() ([]*tlv.Block, error)

Encode encodes a StrategyChoiceList as a series of blocks.