fch

Documentation

Overview

Package fch provides a simple NDN-FCH client. https://github.com/11th-ndn-hackathon/ndn-fch

Index

• Constants
• type Request
• type Response
  • func Query(ctx context.Context, req Request) (res Response, e error)
  • func (res Response) UpdatedTime() time.Time
• type Router

Constants

const (
	DefaultServer    = "https://fch.ndn.today"
	DefaultTransport = "udp"
)

Types

type Request

type Request struct {
	// Server is NDN-FCH server base URI.
	Server string `schema:"-"`

	// Transport specifies a transport protocol.
	Transport string `schema:"cap"`

	// Count specifies number of requested routers.
	Count int `schema:"k"`

	// Network specifies desired network operator.
	Network string `schema:"network,omitempty"`
}

Request represents an NDN-FCH request.

type Response

type Response struct {
	Updated int64    `json:"updated"`
	Routers []Router `json:"routers"`
}

Response represents an NDN-FCH response.

func Query

func Query(ctx context.Context, req Request) (res Response, e error)

Query performs an NDN-FCH query.

func (Response) UpdatedTime

func (res Response) UpdatedTime() time.Time

UpdatedTime returns last updated time. Returns zero value if last updated time is unknown.

type Router

type Router struct {
	Transport string   `json:"transport"`
	Connect   string   `json:"connect"`
	Prefix    ndn.Name `json:"prefix,omitempty"`
}

Router describes a router in NDN-FCH response.