fibEntryList.h File Reference

A typesafe list of FibEntry. More...

#include <hicn/processor/fibEntry.h>

Include dependency graph for fibEntryList.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct fib_entry_list	FibEntryList

Functions
FibEntryList *	fibEntryList_Create (void)
void	fibEntryList_Destroy (FibEntryList **listPtr)
void	fibEntryList_Append (FibEntryList *list, FibEntry *fibEntry)
size_t	fibEntryList_Length (const FibEntryList *list)
const FibEntry *	fibEntryList_Get (const FibEntryList *list, size_t index)

Detailed Description

A typesafe list of FibEntry.

<#Detailed Description#>

Function Documentation

fibEntryList_Append()

void fibEntryList_Append	(	FibEntryList *	list,
		FibEntry *	fibEntry
	)

@function fibEntryList_Append @abstract Will store a reference counted copy of the entry. @discussion Will create and store a reference counted copy. You keep ownership of the parameter fibEntry.

Parameters

<

param1::>

Returns

<#return#>

fibEntryList_Create()

FibEntryList* fibEntryList_Create

(

void

)

Creates an emtpy FIB entry list

Must be destroyed with fibEntryList_Destroy.

Return values

non-null	An allocated FibEntryList
null	An error

Example:

<#example#>

fibEntryList_Destroy()

void fibEntryList_Destroy

(

FibEntryList **

listPtr

)

@function FibEntryList_Detroy @abstract Destroys the list and all entries. @discussion <#Discussion#>

Parameters

<

param1::>

fibEntryList_Get()

const FibEntry* fibEntryList_Get	(	const FibEntryList *	list,
		size_t	index
	)

@function fibEntryList_Get @abstract Gets an element. This is the internal reference, do not destroy. @discussion Returns an internal reference from the list. You must not destroy it. Will assert if you go off the end of the list.

Parameters

<

param1::>

Returns

<#return#>

fibEntryList_Length()

size_t fibEntryList_Length

(

const FibEntryList *

list

)

Returns the number of entries in the list

<#Paragraphs Of Explanation#>

Parameters

[in]

list

An allocated FibEntryList

Return values

number

The number of entries in the list

Example:

<#example#>