object

func (*Client) AnnouncePrefix ¶ added in v1.5.2

func (c *Client) AnnouncePrefix(args ndn.Announcement)

func (*Client) AttachCommandHandler ¶ added in v1.5.2

func (c *Client) AttachCommandHandler(
	handlerName enc.Name,
	handler func(enc.Name, enc.Wire, func(enc.Wire) error),
) error

func (*Client) Consume ¶

func (c *Client) Consume(name enc.Name, callback func(status ndn.ConsumeState))

Consume an object with a given name

func (*Client) ConsumeExt ¶ added in v1.4.3

func (c *Client) ConsumeExt(args ndn.ConsumeExtArgs)

ConsumeExt is a more advanced consume API that allows for more control over the fetching process.

func (*Client) DetachCommandHandler ¶ added in v1.5.2

func (c *Client) DetachCommandHandler(name enc.Name) error

func (*Client) Engine ¶

func (c *Client) Engine() ndn.Engine

Get the underlying engine

func (*Client) ExpressCommand ¶ added in v1.5.2

func (c *Client) ExpressCommand(dest enc.Name, name enc.Name, cmd enc.Wire, callback func(enc.Wire, error))

func (*Client) ExpressR ¶

func (c *Client) ExpressR(args ndn.ExpressRArgs)

Express a single interest with reliability

func (*Client) GetLocal ¶ added in v1.5.0

func (c *Client) GetLocal(name enc.Name) (enc.Wire, error)

GetLocal returns the object data from the store

func (*Client) IsCongested ¶ added in v1.5.0

func (c *Client) IsCongested() bool

IsCongested returns true if the client is congested

func (*Client) LatestLocal ¶ added in v1.5.0

func (c *Client) LatestLocal(name enc.Name) (enc.Name, error)

LatestLocal returns the latest version name of an object in the store

func (*Client) Produce ¶

func (c *Client) Produce(args ndn.ProduceArgs) (enc.Name, error)

Produce and sign data, and insert into the client's store. The input data will be freed as the object is segmented.

func (*Client) Remove ¶ added in v1.4.3

func (c *Client) Remove(name enc.Name) error

Remove an object from the client's store by name

func (*Client) Start ¶

func (c *Client) Start() error

Start the client. The engine must be running.

func (*Client) Stop ¶

func (c *Client) Stop() error

Stop the client

func (*Client) Store ¶ added in v1.4.3

func (c *Client) Store() ndn.Store

Get the underlying store

func (*Client) String ¶ added in v1.4.3

func (c *Client) String() string

Instance log identifier

func (*Client) SuggestSigner ¶ added in v1.4.3

func (c *Client) SuggestSigner(name enc.Name) ndn.Signer

SuggestSigner returns the signer for a given name nil is returned if no signer is found

func (*Client) Validate ¶ added in v1.4.3

func (c *Client) Validate(data ndn.Data, sigCov enc.Wire, callback func(bool, error))

Validate a data packet using the client configuration

func (*Client) ValidateExt ¶ added in v1.4.3

func (c *Client) ValidateExt(args ndn.ValidateExtArgs)

ValidateExt is an advanced API for validating data packets

func (*Client) WithdrawPrefix ¶ added in v1.5.2

func (c *Client) WithdrawPrefix(name enc.Name, onError func(error))

func (*ConsumeState) Cancel ¶ added in v1.5.0

func (a *ConsumeState) Cancel()

cancel the consume operation

func (*ConsumeState) Content ¶

func (a *ConsumeState) Content() enc.Wire

returns the currently available buffer in the content any subsequent calls to Content() will return data after the previous call

func (*ConsumeState) Error ¶

func (a *ConsumeState) Error() error

returns the error that occurred during fetching

func (*ConsumeState) IsComplete ¶

func (a *ConsumeState) IsComplete() bool

returns true if the content has been completely fetched

func (*ConsumeState) Name ¶

func (a *ConsumeState) Name() enc.Name

returns the name of the object being consumed

func (*ConsumeState) Progress ¶

func (a *ConsumeState) Progress() int

get the progress counter

func (*ConsumeState) ProgressMax ¶

func (a *ConsumeState) ProgressMax() int

get the max value for the progress counter (-1 for unknown)

func (*ConsumeState) Version ¶ added in v1.5.0

func (a *ConsumeState) Version() uint64

returns the version of the object being consumed