route.h File Reference

#include <stdint.h>

Include dependency graph for route.h:

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

Go to the source code of this file.

Classes
struct	_route_entry_
struct	_route_entry_info_

Typedefs
typedef struct _route_entry_	AuRouteEntry
typedef struct _route_entry_info_	AuRouteEntryInfo

Functions
void	AuRouteTableInitialise ()
	AuRouteTableInitialise – initialise the kernel route table.
AuRouteEntry *	AuRouteTableCreateEntry ()
	AuRouteTableCreateEntry – create a new route table entry and return.
void	AuRouteTableAdd (AuRouteEntry *entry)
	AuRouteTableAdd – add an entry to route table.
void	AuRouteTableDelete (AuRouteEntry *entry)
	AuRouteTableDelete – delete an entry from route table.
int	AuRouteTableGetNumEntry ()
	AuRouteTableGetNumEntry – returns the number route entry present in the system.
void	AuRouteTablePopulate (AuRouteEntry *whereToPopulate, int entryIndex)
	AuRouteTablePopulate – populates a given memory pointer with route table entry indexed by entryIndex number.
AuRouteEntry *	AuRouteTableDoRouteLookup (uint32_t address)
	AuRouteTableDoRouteLookup – takes the decision on taking the best route.

Typedef Documentation

AuRouteEntry

typedef struct _route_entry_ AuRouteEntry

BSD 2-Clause License

Copyright (c) 2022-2024, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

AuRouteEntryInfo

typedef struct _route_entry_info_ AuRouteEntryInfo

Function Documentation

AuRouteTableAdd()

void AuRouteTableAdd ( AuRouteEntry *  entry )

extern

AuRouteTableAdd – add an entry to route table.

Parameters

entry

– Entry to add

AuRouteTableCreateEntry()

AuRouteEntry * AuRouteTableCreateEntry ( )

extern

AuRouteTableCreateEntry – create a new route table entry and return.

AuRouteTableDelete()

void AuRouteTableDelete ( AuRouteEntry *  entry )

extern

AuRouteTableDelete – delete an entry from route table.

Parameters

entry

– entry to delete

AuRouteTableDoRouteLookup()

AuRouteEntry * AuRouteTableDoRouteLookup ( uint32_t  address )

extern

AuRouteTableDoRouteLookup – takes the decision on taking the best route.

Parameters

address

– address to take for routing

AuRouteTableGetNumEntry()

int AuRouteTableGetNumEntry ( )

extern

AuRouteTableGetNumEntry – returns the number route entry present in the system.

AuRouteTableInitialise()

void AuRouteTableInitialise ( )

extern

AuRouteTableInitialise – initialise the kernel route table.

@TODO: use different data structure for performance demands in future, currently linked list is used

AuRouteTablePopulate()

void AuRouteTablePopulate ( AuRouteEntry *  whereToPopulate, int  entryIndex  )

extern

AuRouteTablePopulate – populates a given memory pointer with route table entry indexed by entryIndex number.

Parameters

whereToPopulate	– memory pointer where to populate with an entry
entryIndex	– entry index number