ndn

package

Go to main page

Versions in this module

v1

v1.5.3

Dec 30, 2025

Changes in this version

type ConsumeExtArgs

+ IgnoreValidity optional.Optional[bool]

type ValidateExtArgs

+ IgnoreValidity optional.Optional[bool]

v1.5.2

Apr 27, 2025

Changes in this version

+ type Announcement struct

+ Cost uint64

+ Expose bool

+ Name enc.Name

+ OnError func(error)

type Client

+ AnnouncePrefix func(args Announcement)

+ AttachCommandHandler func(name enc.Name, ...) error

+ DetachCommandHandler func(name enc.Name) error

+ ExpressCommand func(dest enc.Name, name enc.Name, cmd enc.Wire, callback func(enc.Wire, error))

+ WithdrawPrefix func(name enc.Name, onError func(error))

type Data

+ CrossSchema func() enc.Wire

type DataConfig

+ CrossSchema enc.Wire

type Engine

+ Face func() Face

+ type Face interface

+ Close func() error

+ IsLocal func() bool

+ IsRunning func() bool

+ OnDown func(onDown func()) (cancel func())

+ OnError func(onError func(err error))

+ OnPacket func(onPkt func(frame []byte))

+ OnUp func(onUp func()) (cancel func())

+ Open func() error

+ Send func(pkt enc.Wire) error

+ String func() string

type ValidateExtArgs

+ UseDataNameFwHint optional.Optional[bool]

v1.5.1

Apr 16, 2025

Changes in this version

type ConsumeExtArgs

+ TryStore bool

type Engine

+ Post func(func())

+ String func() string

type ExpressCallbackArgs

+ IsLocal bool

type ExpressRArgs

+ TryStore Store

type Store

+ RemoveFlatRange func(prefix enc.Name, first enc.Component, last enc.Component) error

+ RemovePrefix func(prefix enc.Name) error

v1.5.0

Feb 15, 2025

Changes in this version

+ const MaxNDNPacketSize

+ var ErrCancelled = errors.New("operation cancelled")

+ var ErrNetwork = errors.New("network error")

+ var ErrProtocol = errors.New("protocol error")

+ var ErrSecurity = errors.New("security error")

type Client

+ GetLocal func(name enc.Name) (enc.Wire, error)

+ IsCongested func() bool

+ LatestLocal func(name enc.Name) (enc.Name, error)

type ConsumeExtArgs

+ OnProgress func(status ConsumeState)

type ConsumeState

+ Cancel func()

+ Version func() uint64

type ContentType

+ const ContentTypeEncapsulatedData

+ const ContentTypeManifest

+ const ContentTypePrefixAnnouncement

+ const ContentTypeSigningKey

type Engine

+ SetCmdSec func(signer Signer, validator func(enc.Name, enc.Wire, Signature) bool)

v1.4.3

Jan 25, 2025

Changes in this version

+ var ErrNoPubKey = errors.New("public key does not exist")

+ type Client interface

+ Consume func(name enc.Name, callback func(status ConsumeState) bool)

+ ConsumeExt func(args ConsumeExtArgs)

+ Engine func() Engine

+ ExpressR func(args ExpressRArgs)

+ Produce func(args ProduceArgs) (enc.Name, error)

+ Remove func(name enc.Name) error

+ Start func() error

+ Stop func() error

+ Store func() Store

+ String func() string

+ SuggestSigner func(name enc.Name) Signer

+ Validate func(data Data, sigCov enc.Wire, callback func(bool, error))

+ ValidateExt func(args ValidateExtArgs)

+ type ConsumeExtArgs struct

+ Callback func(status ConsumeState) bool

+ Name enc.Name

+ NoMetadata bool

+ type ConsumeState interface

+ Content func() []byte

+ Error func() error

+ IsComplete func() bool

+ Name func() enc.Name

+ Progress func() int

+ ProgressMax func() int

type ContentType

+ const ContentTypeSigKey

type DataConfig

+ SigNotAfter *time.Time

+ SigNotBefore *time.Time

+ type ExpressRArgs struct

+ AppParam enc.Wire

+ Callback ExpressCallbackFunc

+ Config *InterestConfig

+ Name enc.Name

+ Retries int

+ Signer Signer

type InterestConfig

+ NextHopId *uint64

+ SigNonce []byte

+ SigSeqNo *uint64

+ SigTime *time.Duration

type InterestResult

+ func (r InterestResult) String() string

+ type KeyChain interface

+ Identities func() []KeyChainIdentity

+ IdentityByName func(enc.Name) KeyChainIdentity

+ InsertCert func([]byte) error

+ InsertKey func(Signer) error

+ Store func() Store

+ String func() string

+ type KeyChainIdentity interface

+ Keys func() []KeyChainKey

+ Name func() enc.Name

+ type KeyChainKey interface

+ KeyName func() enc.Name

+ Signer func() Signer

+ UniqueCerts func() []enc.Name

+ type ProduceArgs struct

+ Content enc.Wire

+ FreshnessPeriod time.Duration

+ Name enc.Name

+ NoMetadata bool

+ Version *uint64

type SigType

+ func (t SigType) String() string

type Signer

+ KeyLocator func() enc.Name

+ KeyName func() enc.Name

+ Public func() ([]byte, error)

+ Sign func(enc.Wire) ([]byte, error)

+ Type func() SigType

+ type TrustSchema interface

+ Check func(pkt enc.Name, cert enc.Name) bool

+ Suggest func(enc.Name, KeyChain) Signer

+ type ValidateExtArgs struct

+ Callback func(bool, error)

+ CertNextHop *uint64

+ Data Data

+ OverrideName enc.Name

+ SigCovered enc.Wire

v1.4.2

Jan 3, 2025

v1.4.1

Dec 24, 2024

v1.4.0

Dec 24, 2024

Changes in this version

+ var ErrDeadlineExceed = errors.New("interest deadline exceeded")

+ var ErrFaceDown = errors.New("face is down. Unable to send packet")

+ var ErrFailedToEncode = errors.New("failed to encode an NDN packet")

+ var ErrMultipleHandlers = errors.New("multiple handlers attached to the same prefix")

+ var ErrWrongType = errors.New("packet to parse is not of desired type")

+ type ContentType uint

+ const ContentTypeBlob

+ const ContentTypeKey

+ const ContentTypeLink

+ const ContentTypeNack

+ type Data interface

+ Content func() enc.Wire

+ ContentType func() *ContentType

+ FinalBlockID func() *enc.Component

+ Freshness func() *time.Duration

+ Name func() enc.Name

+ Signature func() Signature

+ type DataConfig struct

+ ContentType *ContentType

+ FinalBlockID *enc.Component

+ Freshness *time.Duration

+ type EncodedData struct

+ Config *DataConfig

+ SigCovered enc.Wire

+ Wire enc.Wire

+ type EncodedInterest struct

+ Config *InterestConfig

+ FinalName enc.Name

+ SigCovered enc.Wire

+ Wire enc.Wire

+ type Engine interface

+ AttachHandler func(prefix enc.Name, handler InterestHandler) error

+ DetachHandler func(prefix enc.Name) error

+ EngineTrait func() Engine

+ ExecMgmtCmd func(module string, cmd string, args any) error

+ Express func(interest *EncodedInterest, callback ExpressCallbackFunc) error

+ IsRunning func() bool

+ RegisterRoute func(prefix enc.Name) error

+ Spec func() Spec

+ Start func() error

+ Stop func() error

+ Timer func() Timer

+ UnregisterRoute func(prefix enc.Name) error

+ type ErrInvalidValue struct

+ Item string

+ Value any

+ func (e ErrInvalidValue) Error() string

+ type ErrNotSupported struct

+ Item string

+ func (e ErrNotSupported) Error() string

+ type ExpressCallbackArgs struct

+ Data Data

+ Error error

+ NackReason uint64

+ RawData enc.Wire

+ Result InterestResult

+ SigCovered enc.Wire

+ type ExpressCallbackFunc func(args ExpressCallbackArgs)

+ type Interest interface

+ AppParam func() enc.Wire

+ CanBePrefix func() bool

+ ForwardingHint func() []enc.Name

+ HopLimit func() *uint

+ Lifetime func() *time.Duration

+ MustBeFresh func() bool

+ Name func() enc.Name

+ Nonce func() *uint64

+ Signature func() Signature

+ type InterestConfig struct

+ CanBePrefix bool

+ ForwardingHint []enc.Name

+ HopLimit *uint

+ Lifetime *time.Duration

+ MustBeFresh bool

+ Nonce *uint64

+ type InterestHandler func(args InterestHandlerArgs)

+ type InterestHandlerArgs struct

+ Deadline time.Time

+ IncomingFaceId *uint64

+ Interest Interest

+ PitToken []byte

+ RawInterest enc.Wire

+ Reply WireReplyFunc

+ SigCovered enc.Wire

+ type InterestResult int

+ const InterestCancelled

+ const InterestResultData

+ const InterestResultError

+ const InterestResultNack

+ const InterestResultNone

+ const InterestResultTimeout

+ const InterestResultUnverified

+ type SigChecker func(name enc.Name, sigCovered enc.Wire, sig Signature) bool

+ type SigConfig struct

+ KeyName enc.Name

+ Nonce []byte

+ NotAfter *time.Time

+ NotBefore *time.Time

+ SeqNum *uint64

+ SigTime *time.Time

+ Type SigType

+ type SigType int

+ const SignatureDigestSha256

+ const SignatureEd25519

+ const SignatureEmptyTest

+ const SignatureHmacWithSha256

+ const SignatureNone

+ const SignatureSha256WithEcdsa

+ const SignatureSha256WithRsa

+ type Signature interface

+ KeyName func() enc.Name

+ SigNonce func() []byte

+ SigSeqNum func() *uint64

+ SigTime func() *time.Time

+ SigType func() SigType

+ SigValue func() []byte

+ Validity func() (notBefore, notAfter *time.Time)

+ type Signer interface

+ ComputeSigValue func(enc.Wire) ([]byte, error)

+ EstimateSize func() uint

+ SigInfo func() (*SigConfig, error)

+ type Spec interface

+ MakeData func(name enc.Name, config *DataConfig, content enc.Wire, signer Signer) (*EncodedData, error)

+ MakeInterest func(name enc.Name, config *InterestConfig, appParam enc.Wire, signer Signer) (*EncodedInterest, error)

+ ReadData func(reader enc.ParseReader) (Data, enc.Wire, error)

+ ReadInterest func(reader enc.ParseReader) (Interest, enc.Wire, error)

+ type Store interface

+ Begin func() error

+ Commit func() error

+ Get func(name enc.Name, prefix bool) ([]byte, error)

+ Put func(name enc.Name, version uint64, wire []byte) error

+ Remove func(name enc.Name, prefix bool) error

+ Rollback func() error

+ type Timer interface

+ Nonce func() []byte

+ Now func() time.Time

+ Schedule func(time.Duration, func()) func() error

+ Sleep func(time.Duration)

+ type WireReplyFunc func(wire enc.Wire) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL