defn

Documentation

Index

• Constants
• Variables
• type LinkType
• type Pkt
• type Scope
• type State
  • func (s State) String() string
• type URI
  • func DecodeURIString(str string) *URI
  • func MakeDevFaceURI(ifname string) *URI
  • func MakeFDFaceURI(fd int) *URI
  • func MakeInternalFaceURI() *URI
  • func MakeNullFaceURI() *URI
  • func MakeTCPFaceURI(ipVersion int, host string, port uint16) *URI
  • func MakeUDPFaceURI(ipVersion int, host string, port uint16) *URI
  • func MakeUnixFaceURI(path string) *URI
  • func MakeWebSocketClientFaceURI(addr net.Addr) *URI
  • func MakeWebSocketServerFaceURI(u *url.URL) *URI
  • func (u *URI) Canonize() error
  • func (u *URI) IsCanonical() bool
  • func (u *URI) Path() string
  • func (u *URI) PathHost() string
  • func (u *URI) PathZone() string
  • func (u *URI) Port() uint16
  • func (u *URI) Scheme() string
  • func (u *URI) Scope() Scope
  • func (u *URI) String() string
  • func (u *URI) URIType() URIType
• type URIType

Constants

const MaxNDNPacketSize = 8800

MaxNDNPacketSize is the maximum allowed NDN packet size

Variables

var DEFAULT_STRATEGY = STRATEGY_PREFIX.Append(
	enc.NewStringComponent(enc.TypeGenericNameComponent, "best-route"),
	enc.NewVersionComponent(1))

Default forwarding strategy name

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

URL not canonical error

var LOCAL_PREFIX = enc.Name{enc.LOCALHOST, enc.NewStringComponent(enc.TypeGenericNameComponent, "nfd")}

Localhost prefix for NFD

var NON_LOCAL_PREFIX = enc.Name{enc.LOCALHOP, enc.NewStringComponent(enc.TypeGenericNameComponent, "nfd")}

Non-local prefix for NFD

var STRATEGY_PREFIX = LOCAL_PREFIX.Append(enc.NewStringComponent(enc.TypeGenericNameComponent, "strategy"))

Prefix for all stratgies

Types

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   *spec.Packet
	Raw  []byte

	PitToken       []byte
	CongestionMark *uint64
	CachePolicy    *uint64

	IncomingFaceID uint64
	NextHopFaceID  *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 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.