interest.h File Reference

#include "name.h"

Go to the source code of this file.

Data Structures
struct	PInterest
	Parsed Interest packet. More...
struct	InterestGuiders
	Interest guider fields. More...
struct	InterestTemplate
	Template for Interest encoding. More...

Macros
#define	PRI_InterestGuiders   "nonce=%08" PRIx32 " lifetime=%" PRIu32 " hopLimit=%" PRIu8
	printf format string for InterestGuiders. More...
#define	InterestGuiders_Fmt(g)   (g).nonce, (g).lifetime, (g).hopLimit
	printf arguments for InterestGuiders. More...

Typedefs
typedef struct PInterest	PInterest
	Parsed Interest packet. More...
typedef struct InterestGuiders	InterestGuiders
	Interest guider fields. More...
typedef struct InterestTemplate	InterestTemplate
	Template for Interest encoding. More...

Functions
bool	PInterest_Parse (PInterest *interest, struct rte_mbuf *pkt, ParseFor parseFor)
	Parse Interest. More...
bool	PInterest_SelectFwHint (PInterest *interest, int i)
	Retrieve i-th forwarding hint name. More...
Packet *	Interest_ModifyGuiders (Packet *npkt, InterestGuiders guiders, PacketMempools *mp, PacketTxAlign align)
	Modify Interest guiders. More...
Packet *	InterestTemplate_Encode (const InterestTemplate *tpl, struct rte_mbuf *m, LName suffix, uint32_t nonce)
	Encode Interest with InterestTemplate. More...

Macro Definition Documentation

InterestGuiders_Fmt

#define InterestGuiders_Fmt

(

g

)

(g).nonce, (g).lifetime, (g).hopLimit

printf arguments for InterestGuiders.

Parameters

g	InterestGuiders instance.

PRI_InterestGuiders

#define PRI_InterestGuiders   "nonce=%08" PRIx32 " lifetime=%" PRIu32 " hopLimit=%" PRIu8

printf format string for InterestGuiders.

printf("mbuf=%p " PRI_InterestGuiders " suffix", mbuf, InterestGuiders_Fmt(guiders));

Typedef Documentation

InterestGuiders

typedef struct InterestGuiders InterestGuiders

Interest guider fields.

InterestTemplate

typedef struct InterestTemplate InterestTemplate

Template for Interest encoding.

PInterest

typedef struct PInterest PInterest

Parsed Interest packet.

Function Documentation

Interest_ModifyGuiders()

Packet* Interest_ModifyGuiders	(	Packet *	npkt,
		InterestGuiders	guiders,
		PacketMempools *	mp,
		PacketTxAlign	align
	)

Modify Interest guiders.

Parameters

[in]

npkt

original Interest packet.

Returns

cloned and modified Interest packet.

Return values

NULL	allocation failure.

InterestTemplate_Encode()

Packet* InterestTemplate_Encode	(	const InterestTemplate *	tpl,
		struct rte_mbuf *	m,
		LName	suffix,
		uint32_t	nonce
	)

Encode Interest with InterestTemplate.

Parameters

m	a uniquely owned, unsegmented, direct, empty mbuf. It must have InterestTemplateDataroom buffer size.

Returns

encoded packet, converted from m .

PInterest_Parse()

bool PInterest_Parse	(	PInterest *	interest,
		struct rte_mbuf *	pkt,
		ParseFor	parseFor
	)

Parse Interest.

Parameters

pkt	a uniquely owned, possibly segmented, direct mbuf that contains Interest TLV.
parseFor	if set to ParseForApp , skip FwHints.

Returns

whether success.

PInterest_SelectFwHint()

bool PInterest_SelectFwHint	(	PInterest *	interest,
		int	i
	)

Retrieve i-th forwarding hint name.

Returns

whether success.

Precondition

i >= 0 && i < interest->nFwHints

Postcondition

interest->activeFwHint == i

interest->fwHint reflects i-th forwarding hint.