defn

package
v1.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 27, 2025 License: MIT Imports: 15 Imported by: 4

Documentation

Overview

Code generated by ndn tlv codegen DO NOT EDIT.

Index

Constants

View Source 
const MaxNDNPacketSize = ndn.MaxNDNPacketSize

MaxNDNPacketSize is the maximum allowed NDN packet size

Variables

View Source 
var DEFAULT_STRATEGY = STRATEGY_PREFIX.
	Append(enc.NewGenericComponent("best-route")).
	Append(enc.NewVersionComponent(1))

Default forwarding strategy name

View Source 
var ErrNotCanonical = errors.New("URI could not be canonized")

URL not canonical error

View Source 
var LOCAL_PREFIX = enc.Name{enc.LOCALHOST, enc.NewGenericComponent("nfd")}

Localhost prefix for NFD

View Source 
var NON_LOCAL_PREFIX = enc.Name{enc.LOCALHOP, enc.NewGenericComponent("nfd")}

Non-local prefix for NFD

View Source 
var STRATEGY_PREFIX = LOCAL_PREFIX.Append(enc.NewGenericComponent("strategy"))

Prefix for all stratgies

Functions

This section is empty.

Types

type FWThreadCounters added in v1.5.0 

type FWThreadCounters struct {
	NPitEntries           int
	NCsEntries            int
	NInInterests          uint64
	NInData               uint64
	NOutInterests         uint64
	NOutData              uint64
	NSatisfiedInterests   uint64
	NUnsatisfiedInterests uint64
	NCsHits               uint64
	NCsMisses             uint64
}

type FwCachePolicy added in v1.5.0 

type FwCachePolicy struct {
	//+field:natural
	CachePolicyType uint64 `tlv:"0x0335"`
}

func ParseFwCachePolicy added in v1.5.0 

func ParseFwCachePolicy(reader enc.WireView, ignoreCritical bool) (*FwCachePolicy, error)

func (*FwCachePolicy) Bytes added in v1.5.0 

func (value *FwCachePolicy) Bytes() []byte

func (*FwCachePolicy) Encode added in v1.5.0 

func (value *FwCachePolicy) Encode() enc.Wire

type FwCachePolicyEncoder added in v1.5.0 

type FwCachePolicyEncoder struct {
	Length uint
}

func (*FwCachePolicyEncoder) Encode added in v1.5.0 

func (encoder *FwCachePolicyEncoder) Encode(value *FwCachePolicy) enc.Wire

func (*FwCachePolicyEncoder) EncodeInto added in v1.5.0 

func (encoder *FwCachePolicyEncoder) EncodeInto(value *FwCachePolicy, buf []byte)

func (*FwCachePolicyEncoder) Init added in v1.5.0 

func (encoder *FwCachePolicyEncoder) Init(value *FwCachePolicy)

type FwCachePolicyParsingContext added in v1.5.0 

type FwCachePolicyParsingContext struct {
}

func (*FwCachePolicyParsingContext) Init added in v1.5.0 

func (context *FwCachePolicyParsingContext) Init()

func (*FwCachePolicyParsingContext) Parse added in v1.5.0 

func (context *FwCachePolicyParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwCachePolicy, error)

type FwData added in v1.5.0 

type FwData struct {
	//+field:name
	NameV enc.Name `tlv:"0x07"`
	//+field:struct:FwMetaInfo
	MetaInfo *FwMetaInfo `tlv:"0x14"`

	//+field:bool
	ContentV bool `tlv:"0x15"`
	//+field:bool
	SignatureInfo bool `tlv:"0x16"`
	//+field:bool
	SignatureValue bool `tlv:"0x17"`
}

+tlv-model:nocopy

func ParseFwData added in v1.5.0 

func ParseFwData(reader enc.WireView, ignoreCritical bool) (*FwData, error)

func (*FwData) Bytes added in v1.5.0 

func (value *FwData) Bytes() []byte

func (*FwData) Encode added in v1.5.0 

func (value *FwData) Encode() enc.Wire

type FwDataEncoder added in v1.5.0 

type FwDataEncoder struct {
	Length uint

	NameV_length     uint
	MetaInfo_encoder FwMetaInfoEncoder
	// contains filtered or unexported fields
}

func (*FwDataEncoder) Encode added in v1.5.0 

func (encoder *FwDataEncoder) Encode(value *FwData) enc.Wire

func (*FwDataEncoder) EncodeInto added in v1.5.0 

func (encoder *FwDataEncoder) EncodeInto(value *FwData, wire enc.Wire)

func (*FwDataEncoder) Init added in v1.5.0 

func (encoder *FwDataEncoder) Init(value *FwData)

type FwDataParsingContext added in v1.5.0 

type FwDataParsingContext struct {
	MetaInfo_context FwMetaInfoParsingContext
}

func (*FwDataParsingContext) Init added in v1.5.0 

func (context *FwDataParsingContext) Init()

func (*FwDataParsingContext) Parse added in v1.5.0 

func (context *FwDataParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwData, error)

type FwInterest added in v1.5.0 

type FwInterest struct {
	//+field:name
	NameV enc.Name `tlv:"0x07"`
	//+field:bool
	CanBePrefixV bool `tlv:"0x21"`
	//+field:bool
	MustBeFreshV bool `tlv:"0x12"`
	//+field:struct:FwLinks
	ForwardingHintV *FwLinks `tlv:"0x1e"`
	//+field:fixedUint:uint32:optional
	NonceV optional.Optional[uint32] `tlv:"0x0a"`
	//+field:time:optional
	InterestLifetimeV optional.Optional[time.Duration] `tlv:"0x0c"`
	//+field:byte
	HopLimitV *byte `tlv:"0x22"`

	//+field:bool
	ApplicationParameters bool `tlv:"0x24"`
	//+field:bool
	SignatureInfo bool `tlv:"0x2c"`
	//+field:bool
	SignatureValue bool `tlv:"0x2e"`
}

+tlv-model:nocopy

func ParseFwInterest added in v1.5.0 

func ParseFwInterest(reader enc.WireView, ignoreCritical bool) (*FwInterest, error)

func (*FwInterest) Bytes added in v1.5.0 

func (value *FwInterest) Bytes() []byte

func (*FwInterest) Encode added in v1.5.0 

func (value *FwInterest) Encode() enc.Wire

func (*FwInterest) Lifetime added in v1.5.0 

func (p *FwInterest) Lifetime() optional.Optional[time.Duration]

func (*FwInterest) Name added in v1.5.0 

func (p *FwInterest) Name() enc.Name

type FwInterestEncoder added in v1.5.0 

type FwInterestEncoder struct {
	Length uint

	NameV_length uint

	ForwardingHintV_encoder FwLinksEncoder
	// contains filtered or unexported fields
}

func (*FwInterestEncoder) Encode added in v1.5.0 

func (encoder *FwInterestEncoder) Encode(value *FwInterest) enc.Wire

func (*FwInterestEncoder) EncodeInto added in v1.5.0 

func (encoder *FwInterestEncoder) EncodeInto(value *FwInterest, wire enc.Wire)

func (*FwInterestEncoder) Init added in v1.5.0 

func (encoder *FwInterestEncoder) Init(value *FwInterest)

type FwInterestParsingContext added in v1.5.0 

type FwInterestParsingContext struct {
	ForwardingHintV_context FwLinksParsingContext
}

func (*FwInterestParsingContext) Init added in v1.5.0 

func (context *FwInterestParsingContext) Init()

func (*FwInterestParsingContext) Parse added in v1.5.0 

func (context *FwInterestParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwInterest, error)
type FwLinks struct {
	//+field:sequence:enc.Name:name
	Names []enc.Name `tlv:"0x07"`
}
func ParseFwLinks(reader enc.WireView, ignoreCritical bool) (*FwLinks, error)

func (*FwLinks) Bytes added in v1.5.0 

func (value *FwLinks) Bytes() []byte

func (*FwLinks) Encode added in v1.5.0 

func (value *FwLinks) Encode() enc.Wire

type FwLinksEncoder added in v1.5.0 

type FwLinksEncoder struct {
	Length uint

	Names_subencoder []struct {
		Names_length uint
	}
}

func (*FwLinksEncoder) Encode added in v1.5.0 

func (encoder *FwLinksEncoder) Encode(value *FwLinks) enc.Wire

func (*FwLinksEncoder) EncodeInto added in v1.5.0 

func (encoder *FwLinksEncoder) EncodeInto(value *FwLinks, buf []byte)

func (*FwLinksEncoder) Init added in v1.5.0 

func (encoder *FwLinksEncoder) Init(value *FwLinks)

type FwLinksParsingContext added in v1.5.0 

type FwLinksParsingContext struct {
}

func (*FwLinksParsingContext) Init added in v1.5.0 

func (context *FwLinksParsingContext) Init()

func (*FwLinksParsingContext) Parse added in v1.5.0 

func (context *FwLinksParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwLinks, error)

type FwLpPacket added in v1.5.0 

type FwLpPacket struct {
	//+field:fixedUint:uint64:optional
	Sequence optional.Optional[uint64] `tlv:"0x51"`
	//+field:natural:optional
	FragIndex optional.Optional[uint64] `tlv:"0x52"`
	//+field:natural:optional
	FragCount optional.Optional[uint64] `tlv:"0x53"`
	//+field:binary
	PitToken []byte `tlv:"0x62"`
	//+field:struct:FwNetworkNack
	Nack *FwNetworkNack `tlv:"0x0320"`
	//+field:natural:optional
	IncomingFaceId optional.Optional[uint64] `tlv:"0x032C"`
	//+field:natural:optional
	NextHopFaceId optional.Optional[uint64] `tlv:"0x0330"`
	//+field:struct:FwCachePolicy
	CachePolicy *FwCachePolicy `tlv:"0x0334"`
	//+field:natural:optional
	CongestionMark optional.Optional[uint64] `tlv:"0x0340"`

	//+field:wire
	Fragment enc.Wire `tlv:"0x50"`
}

+tlv-model:nocopy

func ParseFwLpPacket added in v1.5.0 

func ParseFwLpPacket(reader enc.WireView, ignoreCritical bool) (*FwLpPacket, error)

func (*FwLpPacket) Bytes added in v1.5.0 

func (value *FwLpPacket) Bytes() []byte

func (*FwLpPacket) Encode added in v1.5.0 

func (value *FwLpPacket) Encode() enc.Wire

type FwLpPacketEncoder added in v1.5.0 

type FwLpPacketEncoder struct {
	Length uint

	Nack_encoder FwNetworkNackEncoder

	CachePolicy_encoder FwCachePolicyEncoder

	Fragment_length uint
	// contains filtered or unexported fields
}

func (*FwLpPacketEncoder) Encode added in v1.5.0 

func (encoder *FwLpPacketEncoder) Encode(value *FwLpPacket) enc.Wire

func (*FwLpPacketEncoder) EncodeInto added in v1.5.0 

func (encoder *FwLpPacketEncoder) EncodeInto(value *FwLpPacket, wire enc.Wire)

func (*FwLpPacketEncoder) Init added in v1.5.0 

func (encoder *FwLpPacketEncoder) Init(value *FwLpPacket)

type FwLpPacketParsingContext added in v1.5.0 

type FwLpPacketParsingContext struct {
	Nack_context FwNetworkNackParsingContext

	CachePolicy_context FwCachePolicyParsingContext
}

func (*FwLpPacketParsingContext) Init added in v1.5.0 

func (context *FwLpPacketParsingContext) Init()

func (*FwLpPacketParsingContext) Parse added in v1.5.0 

func (context *FwLpPacketParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwLpPacket, error)

type FwMetaInfo added in v1.5.0 

type FwMetaInfo struct {
	//+field:natural:optional
	ContentType optional.Optional[uint64] `tlv:"0x18"`
	//+field:time:optional
	FreshnessPeriod optional.Optional[time.Duration] `tlv:"0x19"`

	//+field:bool
	FinalBlockID bool `tlv:"0x1a"`
}

func ParseFwMetaInfo added in v1.5.0 

func ParseFwMetaInfo(reader enc.WireView, ignoreCritical bool) (*FwMetaInfo, error)

func (*FwMetaInfo) Bytes added in v1.5.0 

func (value *FwMetaInfo) Bytes() []byte

func (*FwMetaInfo) Encode added in v1.5.0 

func (value *FwMetaInfo) Encode() enc.Wire

type FwMetaInfoEncoder added in v1.5.0 

type FwMetaInfoEncoder struct {
	Length uint
}

func (*FwMetaInfoEncoder) Encode added in v1.5.0 

func (encoder *FwMetaInfoEncoder) Encode(value *FwMetaInfo) enc.Wire

func (*FwMetaInfoEncoder) EncodeInto added in v1.5.0 

func (encoder *FwMetaInfoEncoder) EncodeInto(value *FwMetaInfo, buf []byte)

func (*FwMetaInfoEncoder) Init added in v1.5.0 

func (encoder *FwMetaInfoEncoder) Init(value *FwMetaInfo)

type FwMetaInfoParsingContext added in v1.5.0 

type FwMetaInfoParsingContext struct {
}

func (*FwMetaInfoParsingContext) Init added in v1.5.0 

func (context *FwMetaInfoParsingContext) Init()

func (*FwMetaInfoParsingContext) Parse added in v1.5.0 

func (context *FwMetaInfoParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwMetaInfo, error)

type FwNetworkNack added in v1.5.0 

type FwNetworkNack struct {
	//+field:natural
	Reason uint64 `tlv:"0x0321"`
}

func ParseFwNetworkNack added in v1.5.0 

func ParseFwNetworkNack(reader enc.WireView, ignoreCritical bool) (*FwNetworkNack, error)

func (*FwNetworkNack) Bytes added in v1.5.0 

func (value *FwNetworkNack) Bytes() []byte

func (*FwNetworkNack) Encode added in v1.5.0 

func (value *FwNetworkNack) Encode() enc.Wire

type FwNetworkNackEncoder added in v1.5.0 

type FwNetworkNackEncoder struct {
	Length uint
}

func (*FwNetworkNackEncoder) Encode added in v1.5.0 

func (encoder *FwNetworkNackEncoder) Encode(value *FwNetworkNack) enc.Wire

func (*FwNetworkNackEncoder) EncodeInto added in v1.5.0 

func (encoder *FwNetworkNackEncoder) EncodeInto(value *FwNetworkNack, buf []byte)

func (*FwNetworkNackEncoder) Init added in v1.5.0 

func (encoder *FwNetworkNackEncoder) Init(value *FwNetworkNack)

type FwNetworkNackParsingContext added in v1.5.0 

type FwNetworkNackParsingContext struct {
}

func (*FwNetworkNackParsingContext) Init added in v1.5.0 

func (context *FwNetworkNackParsingContext) Init()

func (*FwNetworkNackParsingContext) Parse added in v1.5.0 

func (context *FwNetworkNackParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwNetworkNack, error)

type FwPacket added in v1.5.0 

type FwPacket struct {
	//+field:struct:FwInterest:nocopy
	Interest *FwInterest `tlv:"0x05"`
	//+field:struct:FwData:nocopy
	Data *FwData `tlv:"0x06"`
	//+field:struct:FwLpPacket:nocopy
	LpPacket *FwLpPacket `tlv:"0x64"`
}

+tlv-model:nocopy

func ParseFwPacket added in v1.5.0 

func ParseFwPacket(reader enc.WireView, ignoreCritical bool) (*FwPacket, error)

func (*FwPacket) Bytes added in v1.5.0 

func (value *FwPacket) Bytes() []byte

func (*FwPacket) Encode added in v1.5.0 

func (value *FwPacket) Encode() enc.Wire

type FwPacketEncoder added in v1.5.0 

type FwPacketEncoder struct {
	Length uint

	Interest_encoder FwInterestEncoder
	Data_encoder     FwDataEncoder
	LpPacket_encoder FwLpPacketEncoder
	// contains filtered or unexported fields
}

func (*FwPacketEncoder) Encode added in v1.5.0 

func (encoder *FwPacketEncoder) Encode(value *FwPacket) enc.Wire

func (*FwPacketEncoder) EncodeInto added in v1.5.0 

func (encoder *FwPacketEncoder) EncodeInto(value *FwPacket, wire enc.Wire)

func (*FwPacketEncoder) Init added in v1.5.0 

func (encoder *FwPacketEncoder) Init(value *FwPacket)

type FwPacketParsingContext added in v1.5.0 

type FwPacketParsingContext struct {
	Interest_context FwInterestParsingContext
	Data_context     FwDataParsingContext
	LpPacket_context FwLpPacketParsingContext
}

func (*FwPacketParsingContext) Init added in v1.5.0 

func (context *FwPacketParsingContext) Init()

func (*FwPacketParsingContext) Parse added in v1.5.0 

func (context *FwPacketParsingContext) Parse(reader enc.WireView, ignoreCritical bool) (*FwPacket, error)

type LinkType 

type LinkType int

LinkType indicates what type of link a face is. 

const (
	// PointToPoint is a face with one remote endpoint.
	PointToPoint LinkType = 0
	// MultiAccess is a face that communicates with a multicast group.
	MultiAccess LinkType = 1
	// AdHoc communicates on a wireless ad-hoc network.
	AdHoc LinkType = 2
)

type Pkt 

type Pkt struct {
	Name enc.Name
	L3   *FwPacket
	Raw  enc.Wire

	PitToken       []byte
	CongestionMark optional.Optional[uint64]

	IncomingFaceID uint64
	NextHopFaceID  optional.Optional[uint64]
}

Pkt represents a pending packet to be sent or recently received on the link, plus any associated metadata.

type Scope 

type Scope int

Scope indicates the scope of a face 

const (
	// Unknown indicates that the scope is unknown.
	Unknown Scope = -1
	// NonLocal indicates the face is non-local (to another forwarder).
	NonLocal Scope = 0
	// Local indicates the face is local (to an application).
	Local Scope = 1
)

type State 

type State int

State indicates the state of a face 

const (
	// Up indicates the face is up
	Up State = iota
	// Down indicates the face is down
	Down State = iota
	// AdminDown indicates the face is administratively down
	AdminDown State = iota
)

func (State) String 

func (s State) String() string

type URI 

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

URI represents a URI for a face.

func DecodeURIString 

func DecodeURIString(str string) *URI

func MakeDevFaceURI 

func MakeDevFaceURI(ifname string) *URI

MakeDevFaceURI constucts a URI for a network interface.

func MakeFDFaceURI 

func MakeFDFaceURI(fd int) *URI

MakeFDFaceURI constructs a file descriptor URI.

func MakeInternalFaceURI 

func MakeInternalFaceURI() *URI

MakeInternalFaceURI constructs an internal face URI.

func MakeNullFaceURI 

func MakeNullFaceURI() *URI

MakeNullFaceURI constructs a null face URI.

func MakeQuicFaceURI added in v1.5.2 

func MakeQuicFaceURI(addr netip.AddrPort) *URI

MakeQuicFaceURI constructs a URI for an HTTP/3 WebTransport endpoint.

func MakeTCPFaceURI 

func MakeTCPFaceURI(ipVersion int, host string, port uint16) *URI

MakeTCPFaceURI constructs a URI for a TCP face.

func MakeUDPFaceURI 

func MakeUDPFaceURI(ipVersion int, host string, port uint16) *URI

MakeUDPFaceURI constructs a URI for a UDP face.

func MakeUnixFaceURI 

func MakeUnixFaceURI(path string) *URI

MakeUnixFaceURI constructs a URI for a Unix face.

func MakeWebSocketClientFaceURI 

func MakeWebSocketClientFaceURI(addr net.Addr) *URI

MakeWebSocketClientFaceURI constructs a URI for a WebSocket server.

func MakeWebSocketServerFaceURI 

func MakeWebSocketServerFaceURI(u *url.URL) *URI

MakeWebSocketServerFaceURI constructs a URI for a WebSocket server.

func (*URI) Canonize 

func (u *URI) Canonize() error

Canonize attempts to canonize the URI, if not already canonical.

func (*URI) IsCanonical 

func (u *URI) IsCanonical() bool

IsCanonical returns whether the face URI is canonical.

func (*URI) Path 

func (u *URI) Path() string

Path returns the path of the face URI.

func (*URI) PathHost 

func (u *URI) PathHost() string

PathHost returns the host component of the path of the face URI.

func (*URI) PathZone 

func (u *URI) PathZone() string

PathZone returns the zone component of the path of the face URI.

func (*URI) Port 

func (u *URI) Port() uint16

Port returns the port of the face URI.

func (*URI) Scheme 

func (u *URI) Scheme() string

Scheme returns the scheme of the face URI.

func (*URI) Scope 

func (u *URI) Scope() Scope

Scope returns the scope of the URI.

func (*URI) String 

func (u *URI) String() string

func (*URI) URIType 

func (u *URI) URIType() URIType

URIType returns the type of the face URI.

type URIType 

type URIType int

URIType represents the type of the URI.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.