ndn

README

Go-NDN

An experimental work-in-progress client for Named Data Networking. Built as a way for me to reverse-engineer and learn the protocol. Includes a dockerfile for running nfd and nrd.

Development

Start NFD with "fig up".

Documentation

Index

• Variables
• type Face
  • func NewFace(transport Transport) *Face
  • func NewTCPFace(addr string) (*Face, error)
  • func (f *Face) Close() error
  • func (f *Face) ExpressInterest(i *packets.Interest) (*pendingInterest, error)
  • func (f *Face) ProcessEvents() error
  • func (f *Face) Put(d *packets.Data) error
  • func (f *Face) RegisterPrefix(prefix name.Name) (<-chan *packets.Interest, error)
  • func (f *Face) RemovePendingInterest(id uint64)
  • func (f *Face) SetCommandSigningInfo(keyChain *KeyChain, certificateName name.Name)
• type InterestFilter
• type KeyChain
  • func NewKeyChain() *KeyChain
  • func (k *KeyChain) Sign(packet signable, certificateName name.Name, newEncoder encoding.EncoderFactory) error
• type PrefixInterestFilter
  • func (f PrefixInterestFilter) Matches(n name.Name) bool
• type Transport

Variables

var ErrCertificateNotFound = errors.New("certificate not found")

var ErrCommandCertificateNameNotSet = errors.New("registerPrefix: The command certificate name has not been set. You must call setCommandSigningInfo.")

var ErrCommandKeyChainNotSet = errors.New("registerPrefix: The command KeyChain has not been set. You must call setCommandSigningInfo.")

var ErrInvalidPacket = errors.New("invalid packet received")

var ErrNameRequired = errors.New("name is required")

var ErrUnexpectedEventTypeReceived = errors.New("unexpected event type received")

var PacketTooLargeError = errors.New("Packet size exceeds maximum limit")

Types

type Face

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

func NewFace

func NewFace(transport Transport) *Face

func NewTCPFace

func NewTCPFace(addr string) (*Face, error)

func (*Face) Close

func (f *Face) Close() error

func (*Face) ExpressInterest

func (f *Face) ExpressInterest(i *packets.Interest) (*pendingInterest, error)

func (*Face) ProcessEvents

func (f *Face) ProcessEvents() error

func (*Face) Put

func (f *Face) Put(d *packets.Data) error

func (*Face) RegisterPrefix

func (f *Face) RegisterPrefix(prefix name.Name) (<-chan *packets.Interest, error)

func (*Face) RemovePendingInterest

func (f *Face) RemovePendingInterest(id uint64)

func (*Face) SetCommandSigningInfo

func (f *Face) SetCommandSigningInfo(keyChain *KeyChain, certificateName name.Name)

type InterestFilter

type InterestFilter interface {
	Matches(name.Name) bool
}

type KeyChain

type KeyChain struct{}

func NewKeyChain

func NewKeyChain() *KeyChain

func (*KeyChain) Sign

func (k *KeyChain) Sign(packet signable, certificateName name.Name, newEncoder encoding.EncoderFactory) error

type PrefixInterestFilter

type PrefixInterestFilter name.Name

func (PrefixInterestFilter) Matches

func (f PrefixInterestFilter) Matches(n name.Name) bool

type Transport

type Transport interface {
	io.Reader
	io.Writer
	io.Closer
}