0% found this document useful (0 votes)

408 views

EXata 2.2 APIReferenceGuide

QualNet and EXata are registered trademarks of Scalable Network Technologies, Inc. ANTENNA This file describes data structures and functions used by antenna models. EXTERNAL This file defines the generic interface to external modules.

Uploaded by

crist13

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

408 views

EXata 2.2 APIReferenceGuide

Uploaded by

crist13

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 645

EXata/Cyber 2.

2 API Reference Guide

May 2011

Scalable Network Technologies, Inc.

6100 Center Drive, Suite 1250 Los Angeles, CA 90045 Phone: 310-338-3318 Fax: 310-338-7213 http://www.scalable-networks.com

Copyright Information 2011 Scalable Network Technologies, Inc. All rights reserved. QualNet and EXata are registered trademarks of Scalable Network Technologies, Inc. All other trademarks and trade names used are property of their respective companies. Scalable Network Technologies, Inc. 6100 Center Drive, Suite 1250 Los Angeles, CA 90045 Phone: 310-338-3318 Fax: 310-338-7213 http://www.scalable-networks.com

EXata 2.2 API Reference Guide

EXata 2.2 API Specification

EXATA API
3D_MATH

This file describes data structures and functions used to model 3D weather patterns in conjunction with the Weather package.
ANTENNA

This file describes data structures and functions used by antenna models.
ANTENNA_GLOBAL

This file describes additional data structures and functions used by antenna models.
API

This file enumerates the basic message/events exchanged during the simulation process and the various layer functions (initialize, finalize, and event handling functions) and other miscellaneous routines and data structure definitions.
APP_UTIL

This file describes Application Layer utility functions.

APPLICATION LAYER

This file describes data structures and functions used by the Application Layer.
BUFFER

This file describes data structures and functions to implement buffers.

CIRCULAR-BUFFER

This file describes data structures and functions used for circular buffer implementation.
CLOCK

This file describes data structures and functions used for time-related operations.
COORDINATES

This file describes data structures and functions used for coordinates-related operations.
ERROR

This file defines data structures and functions used in error-handling.

EXTERNAL

This file defines the generic interface to external modules.

EXTERNAL_SOCKET

This file describes utilities for managing socket connections to external programs.
EXTERNAL_UTILITIES

This file describes utilities for external interfaces.

FILEIO

This file describes data strucutres and functions used for reading from input files and printing to output files.
GUI

This file describes data structures and functions for interfacing with the QualNet GUI and the other graphical tools.
IP

This file contains data structures and prototypes of functions used by IP.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/index.html[5/24/2011 12:30:32 PM]

EXata 2.2 API Specification

IPv6

Data structures and parameters used in network layer are defined here.
LIST

This file describes the data structures and functions used in the implementation of lists.
MAC LAYER

This file describes data structures and functions used by the MAC Layer.
MAIN

This file contains some common definitions.

MAPPING

This file describes data structures and functions for mapping between node pointers, node identifiers, and node addresses.
MEMORY

This file describes the memory management data structures and functions.
MESSAGE

This file describes the message structure used to implement events and functions for message operations.
MOBILITY

This file describes data structures and functions used by mobility models.
MUTEX

This file describes objects for use in creating critical regions (synchronized access) for global variables or data structures that have to be shared between threads.
NETWORK LAYER

This file describes the data structures and functions used by the Network Layer.
NODE

This file defines the Node data structure and some generic operations on nodes.
PARALLEL

This file describes data structures and functions used for parallel programming.
PARTITION

This file contains declarations of some functions for partition threads.

PHYSICAL LAYER

This file describes data structures and functions used by the Physical Layer. Most of this functionality is enabled/used in the Wireless library.
PROPAGATION

This file describes data structures and functions used by propagation models.
QUEUES

This file describes the member functions of the queue base class.
RANDOM NUMBERS

This file describes functions to generate pseudo-random number streams.

SCHEDULERS

This file describes the member functions of the scheduler base class.
SLIDING-WINDOW

This file describes data structures and functions to implement a sliding window.
TRACE

This file describes data structures and functions used for packet tracing.
TRANSPORT LAYER

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/index.html[5/24/2011 12:30:32 PM]

EXata 2.2 API Specification

This file describes data structures and functions used by the Tansport Layer.
USER

This file describes data structures and functions used by the User Layer.
WALLCLOCK

This file describes methods of the WallClock class whose primary use is to keep track of the amount of real time that has passed during the simulation.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/index.html[5/24/2011 12:30:32 PM]

3D_MATH

EXata 2.2 API Specification

3D_MATH
This file describes data structures and functions used to model 3D weather patterns in conjunction with the Weather package. Constant / Data Structure Summary Type
STRUCT

Name
Vector3

This is used to hold 3D points and vectors. This will eventually be added upon to create a robust class with operator overloading. For now we just need an x, y, z.
STRUCT Triangle3

This struture will hold information for one triangle.

Function / Macro Summary Return Type

Vector3

Summary
MATH_CrossProduct(Vector3 vector1, Vector3 vector2)

Returns a perpendicular vector from 2 given vectors by taking the cross product.
Vector3 MATH_Vector(Vector3 point1, Vector3 point2)

Returns a vector between 2 points

double MATH_Magnitude(Vector3 vector)

Returns the magnitude of a normal (or any other vector)

Vector3 MATH_Normalize(Vector3 vector)

Returns a normalized vector (of exactly length 1)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

Vector3

MATH_Normal(Vector3[] triangle)

Returns the direction the polygon is facing

double MATH_PlaneDistance(Vector3 vector, Vector3 point)

Returns the distance the plane is from the origin (0, 0, 0). It takes the normal to the plane, along with ANY point that lies on the plane (any corner)
BOOL MATH_IntersectedPlane(Vector3[] polygon, Vector3[] line, Vector3& normal, double& originDistance)

Takes a triangle (plane) and line and returns true if they intersected
double MATH_DotProduct(Vector3 vector1, Vector3 vector2)

Returns the dot product between 2 vectors.

double MATH_AngleBetweenVectors(Vector3 vector1, Vector3 vector2)

This returns the angle between 2 vectors

Vector3 MATH_IntersectionPoint(Vector3 normal, Vector3[] line, double distance)

Returns an intersection point of a polygon and a line (assuming intersects the plane)
BOOL MATH_InsidePolygon(Vector3 intersection, Vector3[] polygon, int verticeCount)

Returns true if the intersection point is inside of the polygon

BOOL MATH_IntersectedPolygon(Vector3[] polygon, Vector3[] line, int verticeCount)

Tests collision between a line and polygon

double MATH_Distance(Vector3 point1, Vector3 point2)

Returns the distance between 2 3D points

BOOL MATH_LineIntersects(Vector3[] line1, Vector3[] line2)

Checks whether two lines intersect each other or not.

Vector3 MATH_ReturnLineToLineIntersectionPoint(Vector3[] line1, Vector3[] line2)

Returns the point of intersection between two lines.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

BOOL

MATH_IsPointOnLine(Vector3 point, Vector3[] line)

Returns the whether the given point lies on Line or not.

void MATH_ConvertXYToLatLong(double x1, double y1, double latitude, double longitude)

Converts given cartesian coordinates to Latitide and Longitude

Constant / Data Structure Detail

Structure

Vector3

Structure

This is used to hold 3D points and vectors. This will eventually be added upon to create a robust class with operator overloading. For now we just need an x, y, z. Triangle3

This struture will hold information for one triangle.

Function / Macro Detail Function / Macro MATH_CrossProduct Format Vector3 MATH_CrossProduct (Vector3 vector1, Vector3 vector2) Parameters: Returns a perpendicular vector from 2 given vectors by taking the cross product.
vector1 vector2

- the first vector - the second vector

Returns:
Vector3

- the cross product

MATH_Vector

Vector3 MATH_Vector (Vector3 point1, Vector3 point2) Parameters:

Returns a vector between 2 points

point1 point2

- the first point - the second point

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

Returns:
Vector3

- a vector between the two points

MATH_Magnitude

double MATH_Magnitude (Vector3 vector) Parameters:

Returns the magnitude of a normal (or any other vector)

vector

- a vector

Returns:
double

- the magnitude of the vector

MATH_Normalize

Vector3 MATH_Normalize (Vector3 vector) Parameters:

Returns a normalized vector (of exactly length 1)

vector

- a vector

Returns:
Vector3

- a normalized vector

MATH_Normal

Vector3 MATH_Normal (Vector3[] triangle) Parameters:

Returns the direction the polygon is facing

triangle

- an array of vectors representing a polygon

Returns:
Vector3

- the direction vector

MATH_PlaneDistance

double MATH_PlaneDistance (Vector3 vector, Vector3 point) Parameters:

Returns the distance the plane is from the origin (0, 0, 0). It takes the normal to the plane, along with ANY point that lies on the plane (any corner)

vector point

- a vector

- a point

Returns:
double

- the plane's distance from the origin (0,0,0)

MATH_IntersectedPlane

BOOL MATH_IntersectedPlane (Vector3[] polygon, Vector3[] line, Vector3& normal, double& originDistance) Parameters:

Takes a triangle (plane) and line and returns true if they intersected

polygon line

- a polygon

- a line - a normalized vector

normal

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

originDistance

- the distance

Returns:
BOOL

- True if they intersect

MATH_DotProduct

double MATH_DotProduct (Vector3 vector1, Vector3 vector2) Parameters:

Returns the dot product between 2 vectors.

vector1 vector2

- the first vector - the second vector

Returns:
double

- the dot product of the two vectors

MATH_AngleBetweenVectors

double MATH_AngleBetweenVectors (Vector3 vector1, Vector3 vector2) Parameters:

This returns the angle between 2 vectors

vector1 vector2

- the first vector - the second vector

Returns:
double

- None

MATH_IntersectionPoint

Vector3 MATH_IntersectionPoint (Vector3 normal, Vector3[] line, double distance) Parameters:

Returns an intersection point of a polygon and a line (assuming intersects the plane)

normal line

- a polygon

- a line - the distance between?

distance

Returns:
Vector3

- None

MATH_InsidePolygon

BOOL MATH_InsidePolygon (Vector3 intersection, Vector3[] polygon, int verticeCount) Parameters:

Returns true if the intersection point is inside of the polygon

intersection polygon

- an intersection point

- a polygon - number of points in polygon

verticeCount

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

Returns:
BOOL

- True if the intersection point is in the polygon

MATH_IntersectedPolygon

BOOL MATH_IntersectedPolygon (Vector3[] polygon, Vector3[] line, int verticeCount) Parameters:

Tests collision between a line and polygon

polygon line

- a polygon

- a line - number of points in polygon

verticeCount

Returns:
BOOL

- True if the polygon and line intersect

MATH_Distance

double MATH_Distance (Vector3 point1, Vector3 point2) Parameters:

Returns the distance between 2 3D points

point1 point2

- the first point - the second point

Returns:
double

- the distance between the two points

MATH_LineIntersects

BOOL MATH_LineIntersects (Vector3[] line1, Vector3[] line2) Parameters:

Checks whether two lines intersect each other or not.

line1 line2

- the first line - the second line

Returns:
BOOL

- True if the lines intersect

MATH_ReturnLineToLineIntersectionPoint

Vector3 MATH_ReturnLineToLineIntersectionPoint (Vector3[] line1, Vector3[] line2) Parameters:

Returns the point of intersection between two lines.

line1 line2

- the first line - the second line

Returns:
Vector3

- the intersection point

MATH_IsPointOnLine

BOOL MATH_IsPointOnLine (Vector3 point, Vector3[] line)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

3D_MATH

Parameters: Returns the whether the given point lies on Line or not.
point line

- the point which we are checking.

- the line on which the point might lie.

Returns:
BOOL

- TRUE if the point lies on line

MATH_ConvertXYToLatLong

void MATH_ConvertXYToLatLong (double x1, double y1, double latitude, double longitude) Parameters:

Converts given cartesian coordinates to Latitide and Longitude

x1 y1

- Specifies X value on X-Axis - Specifies Y value on Y-Axis - Will store the converted latitude value - Will store the converted longitude value

latitude

longitude

Returns:
void

- NULL

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/3D_MATH.html[5/24/2011 12:31:02 PM]

ANTENNA

EXata 2.2 API Specification

ANTENNA
This file describes data structures and functions used by antenna models. Constant / Data Structure Summary Type
CONSTANT

Name
ANTENNA_DEFAULT_HEIGHT

Default height of the antenna

CONSTANT ANTENNA_DEFAULT_GAIN_dBi

Default gain of the antenna

CONSTANT ANTENNA_DEFAULT_EFFICIENCY

Default efficiency of the antenna

CONSTANT ANTENNA_DEFAULT_MISMATCH_LOSS_dB

Default mismatch loss of the antenna

CONSTANT ANTENNA_DEFAULT_CONNECTION_LOSS_dB

Default connection loss of the antenna

CONSTANT ANTENNA_DEFAULT_CABLE_LOSS_dB

Default cable loss of the antenna

CONSTANT ANTENNA_LOWEST_GAIN_dBi

Default minimum gain of the antenna

CONSTANT ANTENNA_DEFAULT_PATTERN

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Default Pattern
CONSTANT ANTENNA_OMNIDIRECTIONAL_PATTERN

OMNIDIRECTIONAL PATTERN
CONSTANT ANTENNA_PATTERN_NOT_SET

Const for Pattern of antenna not set

CONSTANT AZIMUTH_INDEX

Const for azimuth index of antenna Pattern

CONSTANT ELEVATION_INDEX

Const for elevation index of antenna Pattern

CONSTANT MAX_ANTENNA_NUM_LINES

Const for the line number in the antennaModelInput

CONSTANT AZIMUTH_ELEVATION_INDEX

Const for the memory allocation of azimuth and elevation gain array.
CONSTANT NSMA_PATTERN_START_LINE_NUMBER

Const represents the basic pattern starting point in NSMA file

CONSTANT NSMA_MAX_STARTLINE

Const represents the Revised pattern max line number where the revised NSMA pattern can start.

Function / Macro Summary Return Type

void

Summary
ANTENNA_Init(Node* node, int phyIndex, const NodeInput* nodeInput)

Initialize antennas.
void ANTENNA_ReadPatterns(Node* node, int phyIndex, const NodeInput* antennaInput, int* numPatterns, int* steerablePatternSetRepeatSectorAngle, float*** pattern_dB, BOOL azimuthPlane)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Read in the azimuth pattern file.

void ANTENNA_ReadNsmaPatterns(Node* node, int phyIndex)

Read in the NSMA pattern file.

void ANTENNA_ReadRevisedNsmaPatterns(Node* node, int phyIndex)

Read in the Revised NSMA pattern file.

void ANTENNA_Read3DAsciiPatterns(Node* node, int phyIndex)

Used to read ASCII 3D pattern file.

void ANTENNA_Read2DAsciiPatterns(Node* node, int phyIndex)

Used to read ASCII 2D pattern file.

void ANTENNA_OmniDirectionalInit(Node* node, const NodeInput* nodeInput, int phyIndex, const AntennaModelGlobal* antennaModel)

Initialize omnidirectional antenna from the antenna model file.

void ANTENNA_OmniDirectionalInitFromConfigFile(Node* node, int phyIndex, const NodeInput* nodeInput)

Initialize omnidirectional antenna from the default.config file.

void ANTENNA_InitFromConfigFile(Node* node, int phyIndex, const NodeInput* nodeInput)

Initialize antenna from the default.config file.

BOOL ANTENNA_IsInOmnidirectionalMode(Node* node, int phyIndex)

Is antenna in omnidirectional mode.

int ANTENNA_ReturnPatternIndex(Node* node, int phyIndex)

Return nodes current pattern index.

float ANTENNA_ReturnHeight(Node* node, int phyIndex)

Return nodes antenna height.

double ANTENNA_ReturnSystemLossIndB(Node* node, int phyIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Return systen loss in dB.

float ANTENNA_GainForThisDirection(Node* node, int phyIndex, Orientation DOA)

Return gain for this direction in dB.

float ANTENNA_GainForThisDirectionWithPatternIndex(Node* node, int phyIndex, int patternIndex, Orientation DOA)

Return gain for this direction for the specified pattern in dB.
float ANTENNA_GainForThisSignal(Node* node, int phyIndex, PropRxInfo* propRxInfo)

Return gain in dB.

float ANTENNA_DefaultGainForThisSignal(Node* node, int phyIndex, PropRxInfo* propRxInfo)

Return default gain in dB.

void ANTENNA_LockAntennaDirection(Node* node, int phyIndex)

Lock antenna to current direction.

void ANTENNA_UnlockAntennaDirection(Node* node, int phyIndex)

Unlock antenna.
BOOL ANTENNA_DirectionIsLocked(Node* node, int phyIndex)

Return if direction antenna is locked.

BOOL ANTENNA_IsLocked(Node* node, int phyIndex)

Return if antenna is locked.

void ANTENNA_SetToDefaultMode(Node* node, int phyIndex)

Set default antenna mode (usally omni).

void ANTENNA_SetToBestGainConfigurationForThisSignal(Node* node, int phyIndex, PropRxInfo* propRxInfo)

Set antenna for best gain using the Rx info.

void ANTENNA_SetBestConfigurationForAzimuth(Node* node, int phyIndex, double azimuth)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Set antenna for best gain using the azimuth.

void ANTENNA_GetSteeringAngle(Node* node, int phyIndex, Orientation* angle)

Get steering angle of the antenna.

void ANTENNA_SetSteeringAngle(Node* node, int phyIndex, Orientation angle)

Set the steering angle of the antenna

void ANTENNA_ReturnAsciiPatternFile(Node* node, int phyIndex, const NodeInput* antennaModelInput)

Read in the ASCII pattern .

void ANTENNA_ReturnNsmaPatternFile(Node* node, int phyIndex, const NodeInput* antennaModelInput, AntennaPatterns* antennaPatterns)

Read in the NSMA pattern .

void ANTENNA_ReturnTraditionalPatternFile(Node* node, int phyIndex, const NodeInput* antennaModelInput)

Used to read Qualnet Traditional pattern file

NodeInput * ANTENNA_MakeAntennaModelInput(Node* node, char* buf)

Reads the antenna configuration parameters into the NodeInput structure.

Constant / Data Structure Detail

Constant

ANTENNA_DEFAULT_HEIGHT 1.5

Constant

Default height of the antenna ANTENNA_DEFAULT_GAIN_dBi 0.0

Constant

Default gain of the antenna ANTENNA_DEFAULT_EFFICIENCY 0.8

Default efficiency of the antenna

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Constant

ANTENNA_DEFAULT_MISMATCH_LOSS_dB 0.3

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Constant

Const for the memory allocation of azimuth and elevation gain array. NSMA_PATTERN_START_LINE_NUMBER 10

Constant

Const represents the basic pattern starting point in NSMA file NSMA_MAX_STARTLINE 41

Const represents the Revised pattern max line number where the revised NSMA pattern can start.

Function / Macro Detail Function / Macro ANTENNA_Init Format void ANTENNA_Init (Node* node, int phyIndex, const NodeInput* nodeInput) Parameters: Initialize antennas.
node

- node being initialized. - interface for which physical to be - structure containing contents of input

phyIndex

nodeInput

Returns:
void

- NULL

ANTENNA_ReadPatterns

void ANTENNA_ReadPatterns (Node* node, int phyIndex, const NodeInput* antennaInput, int* numPatterns, int* steerablePatternSetRepeatSectorAngle, float*** pattern_dB, BOOL azimuthPlane) Parameters:

Read in the azimuth pattern file.

node

- node being used. - interface for which physical to be - structure containing contents of

phyIndex

antennaInput numPatterns

- contains the number of patterns - contains

steerablePatternSetRepeatSectorAngle pattern_dB

- array used to store the gain values - shows whether the file is azimuth

azimuthPlane

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

node

- node being initialized. - pointer to node input

nodeInput phyIndex

- interface for which physical to be - pointer to AntennaModelGlobal

antennaModel

Returns:
void

- NULL

ANTENNA_OmniDirectionalInitFromConfigFile

void ANTENNA_OmniDirectionalInitFromConfigFile (Node* node, int phyIndex, const NodeInput* nodeInput) Parameters:

Initialize omnidirectional antenna from the default.config file.

node

- node being initialized. - interface for which physical to be - structure containing contents of input

phyIndex

nodeInput

Returns:
void

- NULL

ANTENNA_InitFromConfigFile

void ANTENNA_InitFromConfigFile (Node* node, int phyIndex, const NodeInput* nodeInput) Parameters:

Initialize antenna from the default.config file.

node

- node being initialized. - interface for which physical to be - structure containing contents of input

phyIndex

nodeInput

Returns:
void

- NULL

ANTENNA_IsInOmnidirectionalMode

BOOL ANTENNA_IsInOmnidirectionalMode (Node* node, int phyIndex) Parameters:

Is antenna in omnidirectional mode.

node

- node being used - interface for which physical to be use

phyIndex

Returns:
BOOL

- returns TRUE if antenna is in omnidirectional mode

ANTENNA_ReturnPatternIndex

int ANTENNA_ReturnPatternIndex (Node* node, int phyIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Return gain for this direction in dB.

node

- node being used - interface for which physical to be used

phyIndex DOA

- direction of antenna

Returns:
float

- gain in dB

ANTENNA_GainForThisDirectionWithPatternIndex

float ANTENNA_GainForThisDirectionWithPatternIndex (Node* node, int phyIndex, int patternIndex, Orientation DOA) Parameters:

Return gain for this direction for the specified pattern in dB.

node

- node being used

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

node

- node being used - interface for which physical to be used

phyIndex

Returns:
void

- NULL

ANTENNA_UnlockAntennaDirection

void ANTENNA_UnlockAntennaDirection (Node* node, int phyIndex) Parameters:

Unlock antenna.

node

- node being used

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

phyIndex

- interface for which physical to be used

propRxInfo

phyIndex

antennaModelInput

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

Returns:
void

- NULL

ANTENNA_ReturnNsmaPatternFile

void ANTENNA_ReturnNsmaPatternFile (Node* node, int phyIndex, const NodeInput* antennaModelInput, AntennaPatterns* antennaPatterns) Parameters:

Read in the NSMA pattern .

node

- node being used - interface for which - structure containing

phyIndex

antennaModelInput antennaPatterns

- Pointer to

Returns:
void

- NULL

ANTENNA_ReturnTraditionalPatternFile

void ANTENNA_ReturnTraditionalPatternFile (Node* node, int phyIndex, const NodeInput* antennaModelInput) Parameters:

Used to read Qualnet Traditional pattern file

node

- node being used - interface for which - structure containing

phyIndex

antennaModelInput

Returns:
void

- NULL

ANTENNA_MakeAntennaModelInput

NodeInput * ANTENNA_MakeAntennaModelInput (Node* node, char* buf) Parameters:

Reads the antenna configuration parameters into the NodeInput structure.

node buf

- node being used

- Path to input file.

Returns:
NodeInput *

- pointer to nodeInput structure

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA.html[5/24/2011 12:32:00 PM]

ANTENNA_GLOBAL

EXata 2.2 API Specification

ANTENNA_GLOBAL
This file describes additional data structures and functions used by antenna models. Constant / Data Structure Summary Type
CONSTANT

Name
MAX_ANTENNA_MODELS

Maximum number of models to allow.

CONSTANT MAX_ANTENNA_PATTERNS

Maximum number of antenna patterns to allow.

ENUMERATION AntennaModelType

Different types of antenna models supported.

ENUMERATION AntennaPatternType

Different types of antenna pattern types supported.

ENUMERATION NSMAPatternVersion

Different types of NSMA pattern versions supported.

ENUMERATION AntennaGainUnit

Different types of antenna gain units supported.

ENUMERATION AntennaPatternUnit

Different types of antenna pattern units supported.

STRUCT struct_antenna_pattern_element

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

Structure for antenna pattern elements

STRUCT struct_antenna_pattern

Structure for antenna pattern

STRUCT struct_antenna_Global_model

Structure for antenna model

Function / Macro Summary Return Type

void

Summary
ANTENNA_GlobalAntennaModelPreInitialize(PartitionData* partitionData)

Preinitalize the global antenna structs.

void ANTENNA_GlobalAntennaPatternPreInitialize(PartitionData* partitionData)

Preinitalize the global antenna structs.

AntennaPattern* ANTENNA_GlobalModelAssignPattern(Node* node, int phyIndex, const NodeInput* antennaModelInput)

used to assign global radiation pattern for each antenna.

void ANTENNA_GlobalAntennaModelInit(Node* node, int phyIndex, const NodeInput* antennaModelInput)

Reads the antenna configuration parameters into the global antenna model structure.
Void ANTENNA_GlobalAntennaPatternInitFromConfigFile(Node* node, int phyIndex, const char* antennaPatternName, BOOL steer)

Init the antenna pattern structure for pattern name for the Old antenna model.
Void ANTENNA_GlobalAntennaPatternInit(Node* node, int phyIndex, const NodeInput* antennaModelInput, const char* antennaPatternName)

Init the antenna pattern structure for pattern name.

AntennaModelGlobal* ANTENNA_GlobalAntennaModelAlloc(PartitionData* partitionData)

Alloc a new model.

AntennaModelGlobal* ANTENNA_GlobalAntennaModelGet(PartitionData* partitionData, const char* antennaModelName)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

Return the model based on the name.

AntennaPattern* ANTENNA_GlobalAntennaPatternGet(PartitionData* partitionData, const char* antennaPatternName)

Return the antenna pattern based on the name.

void ANTENNA_GeneratePatterName(Node* node, int phyIndex, const NodeInput* antennaModelInput, char* antennaPatternName)

Generate the Pattern name base on Pattern type.

Constant / Data Structure Detail

Constant

MAX_ANTENNA_MODELS 50

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

Structure

Different types of antenna pattern units supported. struct_antenna_pattern_element

Structure

Structure for antenna pattern elements struct_antenna_pattern

Structure

Structure for antenna pattern struct_antenna_Global_model

Structure for antenna model

Function / Macro Detail Function / Macro ANTENNA_GlobalAntennaModelPreInitialize Format void ANTENNA_GlobalAntennaModelPreInitialize (PartitionData* partitionData) Parameters: Preinitalize the global antenna structs.
partitionData

- Pointer to partition data.

Returns:
void

- NULL

ANTENNA_GlobalAntennaPatternPreInitialize

void ANTENNA_GlobalAntennaPatternPreInitialize (PartitionData* partitionData) Parameters:

Preinitalize the global antenna structs.

partitionData

- Pointer to partition data.

Returns:
void

- NULL

ANTENNA_GlobalModelAssignPattern

AntennaPattern* ANTENNA_GlobalModelAssignPattern (Node* node, int phyIndex, const NodeInput* antennaModelInput) Parameters:

used to assign global radiation pattern for each antenna.

node

- node being used. - interface for which physical to be

phyIndex

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

antennaModelInput

- structure containing

Returns:
AntennaPattern*

- Pointer to the global antenna pattern structure.

ANTENNA_GlobalAntennaModelInit

void ANTENNA_GlobalAntennaModelInit (Node* node, int phyIndex, const NodeInput* antennaModelInput) Parameters:

Reads the antenna configuration parameters into the global antenna model structure.

node

- node being used. - interface for which physical to be - structure containing

phyIndex

antennaModelInput

Returns:
void

- NULL

ANTENNA_GlobalAntennaPatternInitFromConfigFile

Void ANTENNA_GlobalAntennaPatternInitFromConfigFile (Node* node, int phyIndex, const char* antennaPatternName, BOOL steer) Parameters:

Init the antenna pattern structure for pattern name for the Old antenna model.

node

- node being used. - interface for which physical to be - antenna pattern name to be

phyIndex

antennaPatternName steer

- A boolean variable to differntiate which

Returns:
Void

- NULL

ANTENNA_GlobalAntennaPatternInit

Void ANTENNA_GlobalAntennaPatternInit (Node* node, int phyIndex, const NodeInput* antennaModelInput, const char* antennaPatternName) Parameters:

Init the antenna pattern structure for pattern name.

node

- node being used. - interface for which physical to be - structure containing - antenna pattern name to be

phyIndex

antennaModelInput

antennaPatternName

Returns:
Void

- NULL

ANTENNA_GlobalAntennaModelAlloc

AntennaModelGlobal* ANTENNA_GlobalAntennaModelAlloc (PartitionData* partitionData)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

Parameters: Alloc a new model.

partitionData

- Pointer to partition data.

Returns:
AntennaModelGlobal*

- Pointer to the global antenna model structure.

ANTENNA_GlobalAntennaModelGet

AntennaModelGlobal* ANTENNA_GlobalAntennaModelGet (PartitionData* partitionData, const char* antennaModelName) Parameters:

Return the model based on the name.

partitionData

- Pointer to partition data. - contains the name of the

antennaModelName

Returns:
AntennaModelGlobal*

- Pointer to the global antenna model structure.

ANTENNA_GlobalAntennaPatternGet

AntennaPattern* ANTENNA_GlobalAntennaPatternGet (PartitionData* partitionData, const char* antennaPatternName) Parameters:

Return the antenna pattern based on the name.

partitionData

- Pointer to partition data. - contains the name of the

antennaPatternName

Returns:
AntennaPattern*

- Pointer to the global antenna pattern structure.

ANTENNA_GeneratePatterName

void ANTENNA_GeneratePatterName (Node* node, int phyIndex, const NodeInput* antennaModelInput, char* antennaPatternName) Parameters:

Generate the Pattern name base on Pattern type.

node

- node being used. - interface for which physical to be - structure containing - antenna pattern name to be

phyIndex

antennaModelInput

antennaPatternName

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

ANTENNA_GLOBAL

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ANTENNA_GLOBAL.html[5/24/2011 12:32:06 PM]

API

EXata 2.2 API Specification

API
This file enumerates the basic message/events exchanged during the simulation process and the various layer functions (initialize, finalize, and event handling functions) and other miscellaneous routines and data structure definitions. Constant / Data Structure Summary Type
ENUMERATION

Name
MESSAGE/EVENT

Event/message types exchanged in the simulation

ENUMERATION TransportType

Transport type to check reliable, unreliable or TADIL network for Link16 or Link11
ENUMERATION DestinationType

Interface IP address type

STRUCT PhyBatteryPower

Used by App layer and Phy layer to exchange battery power

STRUCT PacketNetworkToApp

Network to application layer packet structure

STRUCT NetworkToTransportInfo

Network To Transport layer Information structure

STRUCT PacketTransportNetwork

Transport to network layer packet structure

STRUCT TcpTimerPacket

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

TCP timer packet

STRUCT AppToUdpSend

Additional information given to UDP from applications. This information is saved in the info field of a message.
STRUCT UdpToAppRecv

Additional information given to applications from UDP. This information is saved in the info field of a message.
STRUCT AppToRsvpSend

send response structure from application layer

STRUCT TransportToAppListenResult

Report the result of application's listen request.

STRUCT TransportToAppOpenResult

Report the result of opening a connection.

STRUCT TransportToAppDataSent

Report the result of sending application data.

STRUCT TransportToAppDataReceived

Deliver data to application.

STRUCT TransportToAppCloseResult

Report the result of closing a connection.

STRUCT AppToTcpListen

Application announces willingness to accept connections on given port.

STRUCT AppToTcpOpen

Application attempts to establish a connection

STRUCT AppToTcpSend

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Application wants to send some data over the connection

STRUCT AppToTcpClose

Application wants to release the connection

STRUCT AppToTcpConnSetup

Application sets up connection at the local end Needed for NS TCP to fake connection setup
STRUCT AppQosToNetworkSend

Application uses this structure in its info field to perform the initialization of a new QoS connection with its QoS requirements.
STRUCT NetworkToAppQosConnectionStatus

Q-OSPF uses this structure to report status of a session requested by the application for Quality of Service.

Function / Macro Summary Return Type

void

Summary
CHANNEL_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for channel

void PHY_Init(Node* node, const NodeInput* nodeInput)

Initialization function for physical layer

void MAC_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for the MAC layer

void NETWORK_PreInit(Node* node, const NodeInput* nodeInput)

Pre-Initialization function for Network layer

void NETWORK_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for Network layer

void TRANSPORT_Initialize(Node* node, const NodeInput* nodeInput)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Initialization function for transport layer

void APP_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for Application layer

void USER_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for User layer

void APP_InitializeApplications(Node* firstNode, const NodeInput* nodeInput)

Initialization function for applications in APPLICATION layer

void ATMLAYER2_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for the ATM Layer2.

void ADAPTATION_Initialize(Node* node, const NodeInput* nodeInput)

Initialization function for Adaptation layer

void CHANNEL_Finalize(Node * node)

To collect results of simulation at the end for channels

void PHY_Finalize(Node * node)

To collect results of simulation at the end for the PHYSICAL layer

void MAC_Finalize(Node * node)

To collect results of simulation at the end for the mac layers

void NETWORK_Finalize(Node * node)

To collect results of simulation at the end for network layers

void TRANSPORT_Finalize(Node * node)

To collect results of simulation at the end for transport layers

void APP_Finalize(Node * node)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

To collect results of simulation at the end for application layers

void USER_Finalize(Node * node)

To collect results of simulation at the end for user layers

void ATMLAYER2_Finalize(Node * node)

To collect results at the end of the simulation.

void ADAPTATION_Finalize(Node * node)

To collect results of simulation at the end for network layers

void CHANNEL_ProcessEvent(Node* node, Message* msg)

Processes the message/event of physical layer received by the node thus simulating the PHYSICAL layer behaviour
void PHY_ProcessEvent(Node* node, Message* msg)

Processes the message/event of physical layer received by the node thus simulating the PHYSICAL layer behaviour
void MAC_ProcessEvent(Node* node, Message* msg)

Processes the message/event of MAC layer received by the node thus simulating the MAC layer behaviour
void NETWORK_ProcessEvent(Node* node, Message* msg)

Processes the message/event received by the node thus simulating the NETWORK layer behaviour
void TRANSPORT_ProcessEvent(Node* node, Message* msg)

Processes the message/event received by the node thus simulating the TRANSPORT layer behaviour
void APP_ProcessEvent(Node* node, Message* msg)

Processes the message/event received by the node thus simulating the APPLICATION layer behaviour
void USER_ProcessEvent(Node* node, Message* msg)

Processes the message/event received by the node thus simulating the USER layer behaviour
void ATMLAYER2_ProcessEvent(Node* node, Message* msg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Processes the message/event of ATM_LAYER2 layer received by the node thus simulating the ATM_LAYER2 layer behaviour
void ADAPTATION_ProcessEvent(Node* node, Message* msg)

Processes the message/event received by the node thus simulating the ADAPTATION layer behaviour
void MAC_RunTimeStat(Node* node)

To print runtime statistics for the MAC layer

void NETWORK_RunTimeStat(Node* node)

To print runtime statistics for the NETWORK layer

void TRANSPORT_RunTimeStat(Node* node)

To print runtime statistics for the TRANSPORT layer

void APP_RunTimeStat(Node* node)

To print runtime statistics for the APPLICATION layer

Constant / Data Structure Detail

Enumeration

MESSAGE/EVENT

Enumeration

Event/message types exchanged in the simulation TransportType

Enumeration

Transport type to check reliable, unreliable or TADIL network for Link16 or Link11 DestinationType

Structure

Interface IP address type PhyBatteryPower

Structure

Used by App layer and Phy layer to exchange battery power PacketNetworkToApp

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Structure

Network to application layer packet structure NetworkToTransportInfo

Structure

Report the result of sending application data. TransportToAppDataReceived

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Initialization function for Network layer

node

- node being intialized - structure containing input file details

nodeInput

Returns:
void

Returns:
void

- None

ATMLAYER2_Initialize

void ATMLAYER2_Initialize (Node* node, const NodeInput* nodeInput) Parameters:

Initialization function for the ATM Layer2.

node

- node being intialized - structure containing input file details

nodeInput

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

API

Returns:
void

- None

ADAPTATION_Initialize

void ADAPTATION_Initialize (Node* node, const NodeInput* nodeInput) Parameters:

Initialization function for Adaptation layer

node

- node being intialized - structure containing input file details

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

- Received message structure

Returns:
void

- None

MAC_RunTimeStat

void MAC_RunTimeStat (Node* node) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

void APP_RunTimeStat (Node* node) Parameters:

To print runtime statistics for the APPLICATION layer

node

- node for which statistics to be printed

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/API.html[5/24/2011 12:32:16 PM]

APP_UTIL

EXata 2.2 API Specification

APP_UTIL
This file describes Application Layer utility functions. Function / Macro Summary Return Type
MACRO

Summary
APP_GetTimerType(x)

Get the timerType for a received App Layer Timer.

AppInfo* APP_RegisterNewApp(Node* node, AppType appType, void * dataPtr)

Insert a new application into the list of apps on this node.

void APP_SetTimer(Node* node, AppType appType, int connId, short sourcePort, int timerType, clocktype delay)

Set a new App Layer Timer and send to self after delay.
void APP_UdpSendNewData(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char * payload, int payloadSize, clocktype delay, TraceProtocolType traceProtocol)

Allocate data and send to UDP.

void APP_UdpSendNewDataWithPriority(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 uniqueId)

Allocate data with specified priority and send to UDP.

Message* APP_UdpSendNewDataWithPriority(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 uniqueId)

Allocate data with specified priority and send to UDP (For IPv6).
void APP_UdpSendNewHeaderData(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, char* payload, int payloadSize, clocktype delay, TraceProtocolType traceProtocol)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Allocate header and data and send to UDP..

void APP_UdpSendNewHeaderDataWithPriority(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* header, int headerSize, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol)

Allocate header and data with specified priority and send to UDP
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId)

Allocate header + virtual data with specified priority and send to UDP
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, short destinationPort, char* infoData, int infoSize, int infoType, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId)

Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* infoData, int infoSize, int infoType, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, char* appname, BOOL isMdpEnabled, Int32 mdpUniqueId)

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, char* infoData, int infoSize, int infoType, BOOL isMdpEnabled, Int32 mdpUniqueId)

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol)

Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, AppType appType, Address sourceAddr, short sourcePort, Address destAddr, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, char* mdpInfo, TraceProtocolType traceProtocol, Message* theMsgPtr)

(Overloaded for MDP) Allocate actual + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).
Message * APP_UdpCreateNewHeaderVirtualDataWithPriority.(Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol)

Create the message.

void APP_UdpSendNewHeaderVirtualDataWithPriority(Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId)

Listen on a server port.

void APP_TcpServerListen.(Node * node, AppType appType, Address serverAddr, short serverPort)

(Overloaded for IPv6) Listen on a server port.

void APP_TcpServerListenWithPriority.(Node * node, AppType appType, NodeAddress serverAddr, short serverPort, TosType priority)

Listen on a server port with specified priority.

void APP_TcpServerListenWithPriority.(Node * node, AppType appType, Address serverAddr, short serverPort, TosType priority)

Listen on a server port with specified priority. (Overloaded for IPv6)

void APP_TcpOpenConnection.(Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime)

Open a connection.
void APP_TcpOpenConnection.(Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

(Overloaded for IPv6) Open a connection.

void APP_TcpOpenConnection.(Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime, int outgoingInterface)

Open a connection.
void APP_TcpOpenConnection.(Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime, int outgoingInterface)

(Overloaded for IPv6) Open a connection.

void APP_TcpOpenConnectionWithPriority.(Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime, TosType priority)

Open a connection with specified priority.

void APP_TcpOpenConnectionWithPriority..(Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime, TosType priority)

Open a connection with specified priority. (Overloaded for IPv6)

Message * App_TcpCreateMessage.(Node * node, int connId, char * payload, int length, traceProtocolType traceProtocol)

Create the message.

void APP_TcpSendData.(Node * node, int connId, char * payload, int length, raceProtocolType traceProtocol)

send an application data unit.

Message* APP_TcpSendNewHeaderVirtualData.(Node * node, int connId, char * header, int headerLength, int payloadSize, raceProtocolType traceProtocol)

Send header and virtual data using TCP.

void APP_TcpCloseConnection(Node * node, int connId)

Close the connection.

void APP_InitMulticastGroupMembershipIfAny(Node * node, const NodeInput nodeInput)

Start process of joining multicast group if need to do so.

void APP_CheckMulticastByParsingSourceAndDestString(Node * node, const char * inputString, const char * sourceString, NodeAddress * sourceNodeId, NodeAddress * sourceAddr, const char * destString, NodeAddress * destNodeId, NodeAddress * destAddr, BOOL * isDestMulticast)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Application input parsing API. Parses the source and destination strings.At the same time validates those strings for multicast address.
void APP_ParsingSourceAndDestString(Node * node, const char * inputString, const char * sourceString, NodeAddress * sourceNodeId, NodeAddress * sourceAddr, const char * destString, NodeAddress * destNodeId, NodeAddress * destAddr, DestinationType * destType)

API to parse the input source and destination strings read from the *.app file.At the same time checks and fills the destination type parameter.
void APP_ParsingSourceAndDestString(Node * node, const char * inputString, const char * sourceString, NodeId * sourceNodeId, Address * sourceAddr, const char * destString, NodeId * destNodeId, Address * destAddr, DestinationType * destType)

API to parse the input source and destination strings read from the *.app file. At the same time checks and fills the destination type parameter.
AppInfo* APP_RegisterNewApp(Node* node, AppType appType, void * dataPtr, short myPort)

Also inserts the port number being used for this app in the port table.
BOOL APP_IsFreePort(Node* node, short portNumber)

there is an application running at the node that uses an AppType that has been assigned the same value as this port number. This is done since applications such as CBR use the value of AppType as destination port.
short APP_GetFreePort(Node* node)

void

APP_InserInPortTable(Node* node, AppType appType, short myPort)

short

APP_GetProtocolType(Node* node, Message* msg)

BOOL

APP_AssignTos(char array tosString, char array tosValString, unsigned * tosVal)

Application input parsing API. Parses the tos string and tos value strings.At the same time validates those strings for proper ranges.
Message* APP_UdpCreateNewHeaderVirtualDataWithPriority(Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol)

Allocate header + virtual data with specified priority and send to UDP. Generally used with messenger app.
Message* APP_UdpCreateNewHeaderVirtualDataWithPriority(Node * node, AppType appType, Address sourceAddr, short sourcePort, Address destAddr, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol)

Allocate header + virtual data with specified priority and send to UDP. Generally used with messenger app.
void APP_UnregisterApp(Node* node, void * dataPtr, bool freeData)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Remove an application from list of apps on this node.

void APP_UnregisterApp(Node* node, AppType appType, void * dataPtr, short myPort)

Also Remove the port number being used for this app in the port table.
BOOL APP_IsFreePort(Node* node, short portNumber)

void.

APP_MdpLayerInit(Node* node, Address clientAddr, Address serverAddr, Int32 sourcePort, AppType appType, BOOL isProfileNameSet, char* profileName, Int32 uniqueId, NodeInput* nodeInput, Int32 destPort, BOOL destIsUnicast)

void.

APP_MdpLayerInitForOtherPartitionNodes(Node* node, NodeInput* nodeInput, Address* destAddr, BOOL isUnicast)

. which the calling node exists.

void. APP_MdpQueueDataObject(Node* node, Address localAddr, Address remoteAddr, Int32 uniqueId, Int32 itemSize, char* payload, Int32 virtualSize, Message* theMsg, BOOL isFromAppForward)

void.

APP_MdpNotifyLastDataObject(Node* node, Address localAddr, Address remoteAddr, Int32 uniqueId)

SequenceNumber

APP_ReportStatsDbReceiveEvent(Node* node, Message* msg, SequenceNumber** seqCache, Int64 seqNo, clocktype delay, clocktype jitter, int size, int numRcvd, AppMsgStatus msgStatus)

Report receive event to StatsDB app event table This function will check duplicate and out of order msgs

Function / Macro Detail Function / Macro APP_GetTimerType(x) Format Get the timerType for a received App Layer Timer.

APP_RegisterNewApp

AppInfo* APP_RegisterNewApp (Node* node, AppType appType, void * dataPtr) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Insert a new application into the list of apps on this node.

node

- node that is registering the application. - application type - pointer to the data space for this app

appType dataPtr

Returns:
AppInfo*

- pointer to the new AppInfo data structure for this app

APP_SetTimer

void APP_SetTimer (Node* node, AppType appType, int connId, short sourcePort, int timerType, clocktype delay) Parameters:

Set a new App Layer Timer and send to self after delay.

node

- node that is issuing the Timer. - application type

appType connId

- if applicable, the TCP connectionId for this timer - the source port of the application setting

sourcePort timerType delay

- an integer value that can be used to

- send the timer to self after this delay.

Returns:
void

- None

APP_UdpSendNewData

void APP_UdpSendNewData (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char * payload, int payloadSize, clocktype delay, TraceProtocolType traceProtocol) Parameters:

Allocate data and send to UDP.

node

- node that is sending the data. - application type, to be used as destination port. - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr payload

- the destination node Id data is sent to.

- pointer to the data. - size of the data in bytes.

payloadSize delay

- send the data after this delay. - specify the type of application used for

traceProtocol

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

void

- None

APP_UdpSendNewDataWithPriority

void APP_UdpSendNewDataWithPriority (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 uniqueId) Parameters:
node

Allocate data with specified priority and send to UDP.

- node that is sending the data. - application type, to be used as - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr

- the destination node Id data - interface used to send data.

outgoingInterface payload

- pointer to the data. - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol isMdpEnabled uniqueId

- specify whether MDP is enabled.

- specify uniqueId related to MDP.

Returns:
void

- None

APP_UdpSendNewDataWithPriority

Message* APP_UdpSendNewDataWithPriority (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 uniqueId) Parameters:
node

Allocate data with specified priority and send to UDP (For IPv6).

- node that is sending the data. - application type, to be used as - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr

- the destination node Id data - interface used to send data.

outgoingInterface
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

payload

- pointer to the data. - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol isMdpEnabled uniqueId

- specify whether MDP is enabled.

- specify uniqueId related to MDP.

Returns:
Message*

- The sent message

APP_UdpSendNewHeaderData

void APP_UdpSendNewHeaderData (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, char* payload, int payloadSize, clocktype delay, TraceProtocolType traceProtocol) Parameters:
node

Allocate header and data and send to UDP..

- node that is sending the data. - application type, to be used as - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr header

- the destination node Id data

- header of the payload. - size of the header.

headerSize payload

- pointer to the data. - size of the data in bytes.

payloadSize delay

- send the data after this delay. - specify the type of application

traceProtocol

Returns:
void

- None

APP_UdpSendNewHeaderDataWithPriority

void APP_UdpSendNewHeaderDataWithPriority (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, int outgoingInterface, char* header, int headerSize, char* payload, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol)

Allocate header and data with specified priority and send

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Parameters: to UDP
node

- node that is sending the data. - application type, to be used as - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr

- the destination node Id data - interface used to send data.

outgoingInterface header

- header of the payload. - size of the header.

headerSize payload

- pointer to the data. - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId) Parameters:
node

Allocate header + virtual data with specified priority and send to UDP

- node that is sending the data. - application type, to be used as - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr header

- the destination node Id data

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

- priority of data.

APP_UTIL

delay

- send the data after this delay. - specify the type of application

traceProtocol isMdpEnabled mdpUniqueId

- status of MDP layer.

- unique id for MPD session.

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, short destinationPort, char* infoData, int infoSize, int infoType, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId) Parameters:
node

Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort infoData infoSize infoType

- UDP header to be added in info. - size of the UDP header. - info type of the UDP header. - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol isMdpEnabled mdpUniqueId

- status of MDP layer.

- unique id for MPD session.

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

(Overloaded for IPv6) Allocate header + virtual data

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* infoData, int infoSize, int infoType, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, char* appname, BOOL isMdpEnabled, Int32 mdpUniqueId)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

Parameters:
node

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort infoData infoSize infoType

- UDP header to be added. - size of the UDP header. - info type of the UDP header - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol appname

- Application name. - status of MDP layer.

isMdpEnabled mdpUniqueId

- unique id for MPD session.

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, char* infoData, int infoSize, int infoType, BOOL isMdpEnabled, Int32 mdpUniqueId) Parameters:
node

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort header

- header of the payload.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

headerSize

- size of the header. - size of the data in bytes.

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol infoData infoSize infoType

- UDP header to be added. - size of the UDP header. - info type of the UDP header - status of MDP layer.

isMdpEnabled mdpUniqueId

- unique id for MPD session.

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol) Parameters:
node

Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort header

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, AppType appType, Address sourceAddr, short sourcePort, Address destAddr, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, char* mdpInfo, TraceProtocolType traceProtocol, Message* theMsgPtr) Parameters:
node

(Overloaded for MDP) Allocate actual + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - specify the application type. - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr header

- the destination node on which

- pointer to the payload. - size of the payload. - size of the virtual data in bytes.

headerSize

payloadSize priority delay

- priority of data.

- send the data after this delay. - persistent info for Mdp. - specify the type of application

mdpInfo

traceProtocol theMsgPtr

- pointer the original message to copy

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol) Parameters:
node

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort header

- header of the payload. - size of the header.

headerSize
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

payloadSize priority delay

- size of the data in bytes.

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol

Returns:
void

- None

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol) Parameters:
node

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort header

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol

Returns:
void

- None

APP_UdpCreateNewHeaderVirtualDataWithPriority.

Message * APP_UdpCreateNewHeaderVirtualDataWithPriority. (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol) Parameters:
node

Create the message.

- node that is sending the data. - the source sending the data.

sourceAddr

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

sourcePort destAddr

- the application source port.

- the destination node Id data - the destination port

destinationPort header

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority

- priority of data. - specify the type of application

traceProtocol

Returns:
Message *

- message created in the function

APP_UdpSendNewHeaderVirtualDataWithPriority

void APP_UdpSendNewHeaderVirtualDataWithPriority (Node * node, Address sourceAddr, short sourcePort, Address destAddr, short destinationPort, char* header, int headerSize, int payloadSize, TosType priority, clocktype delay, TraceProtocolType traceProtocol, BOOL isMdpEnabled, Int32 mdpUniqueId) Parameters:
node

(Overloaded for IPv6) Allocate header + virtual data with specified priority and send to UDP. Data is sent to a non-default destination port (port number may not have same value as the AppType).

- node that is sending the data. - the source sending the data. - the application source port.

sourceAddr sourcePort destAddr

- the destination node Id data - the destination port

destinationPort header

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority delay

- priority of data.

- send the data after this delay. - specify the type of application

traceProtocol isMdpEnabled mdpUniqueId

- status of MDP layer.

- unique id for MPD session.

appType

serverAddr serverPort priority

- priority of this data for

Returns:
void

- None

APP_TcpServerListenWithPriority.

void APP_TcpServerListenWithPriority. (Node * node, AppType appType, Address serverAddr, short serverPort, TosType priority)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Parameters: Listen on a server port with specified priority. (Overloaded for IPv6)
node

- Node pointer that the protocol is - which application initiates this request - server address - server port number

appType

serverAddr serverPort priority

- priority of this data for

Returns:
void

- None

APP_TcpOpenConnection.

void APP_TcpOpenConnection. (Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime) Parameters:

Open a connection.
node

- Node pointer that the protocol is - which application initiates this request - address of the source node. - port number on the source node. - address of the remote node. - port number on the remote node (server port).

appType

localAddr localPort

remoteAddr remotePort uniqueId waitTime

- used to determine which client is requesting - time until the session starts.

Returns:
void

- None

APP_TcpOpenConnection.

void APP_TcpOpenConnection. (Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime) Parameters:

(Overloaded for IPv6) Open a connection.

node

- Node pointer that the protocol is - which application initiates this request - address of the source node. - port number on the source node. - address of the remote node.

appType

localAddr localPort

remoteAddr
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

remotePort uniqueId waitTime

- port number on the remote node (server port).

- used to determine which client is requesting - time until the session starts.

Returns:
void

- None

APP_TcpOpenConnection.

void APP_TcpOpenConnection. (Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime, int outgoingInterface) Parameters:

Open a connection.
node

appType

localAddr localPort

remoteAddr remotePort uniqueId waitTime

- used to determine which client is requesting - time until the session starts. - User specific outgoing Interface.

outgoingInterface

Returns:
void

- None

APP_TcpOpenConnection.

void APP_TcpOpenConnection. (Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime, int outgoingInterface) Parameters:

(Overloaded for IPv6) Open a connection.

node

appType

localAddr localPort

remoteAddr remotePort uniqueId

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

- used to determine which client is requesting

APP_UTIL

waitTime

- time until the session starts. - User specific outgoing Interface.

outgoingInterface

Returns:
void

- None

APP_TcpOpenConnectionWithPriority.

void APP_TcpOpenConnectionWithPriority. (Node * node, appType appType, NodeAddress localAddr, short localPort, NodeAddress remoteAddr, short remotePort, int uniqueId, clocktype waitTime, TosType priority) Parameters:

Open a connection with specified priority.

node

appType

localAddr localPort

remoteAddr remotePort uniqueId waitTime priority

- used to determine which client is requesting - time until the session starts. - priority of the data.

Returns:
void

- None

APP_TcpOpenConnectionWithPriority..

void APP_TcpOpenConnectionWithPriority.. (Node * node, appType appType, Address localAddr, short localPort, Address remoteAddr, short remotePort, int uniqueId, clocktype waitTime, TosType priority) Parameters:

Open a connection with specified priority. (Overloaded for IPv6)

node

appType

localAddr localPort

remoteAddr remotePort uniqueId

- used to determine which client is requesting

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

waitTime priority

- time until the session starts. - priority of the data.

Returns:
void

- None

App_TcpCreateMessage.

Message * App_TcpCreateMessage. (Node * node, int connId, char * payload, int length, traceProtocolType traceProtocol) Parameters:

Create the message.

node

- Node pointer that the protocol is - connection id. - data to send.

connId

payload length

- length of the data to send. - specify the type of application

traceProtocol

Returns:
Message *

- message created in the function

APP_TcpSendData.

void APP_TcpSendData. (Node * node, int connId, char * payload, int length, raceProtocolType traceProtocol) Parameters:

send an application data unit.

node

- Node pointer that the protocol is - connection id. - data to send.

connId

payload length

- length of the data to send. - specify the type of application

traceProtocol

Returns:
void

- None

APP_TcpSendNewHeaderVirtualData.

Message* APP_TcpSendNewHeaderVirtualData. (Node * node, int connId, char * header, int headerLength, int payloadSize, raceProtocolType traceProtocol) Parameters:

Send header and virtual data using TCP.

node

- Node pointer that the protocol is - connection id. - header to send.

connId header

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

headerLength payloadSize

- length of the header to send.

- size of data to send along with header. - specify the type of application

traceProtocol

Returns:
Message*

- Sent message

APP_TcpCloseConnection

void APP_TcpCloseConnection (Node * node, int connId) Parameters:

Close the connection.

node

- Node pointer that the protocol is - connection id.

connId

Returns:
void

- None

APP_InitMulticastGroupMembershipIfAny

void APP_InitMulticastGroupMembershipIfAny (Node * node, const NodeInput nodeInput) Parameters:

Start process of joining multicast group if need to do so.

node

- node - node that is joining a group. - used to access configuration file.

nodeInput

Returns:
void

- None

APP_CheckMulticastByParsingSourceAndDestString

void APP_CheckMulticastByParsingSourceAndDestString (Node * node, const char * inputString, const char * sourceString, NodeAddress * sourceNodeId, NodeAddress * sourceAddr, const char * destString, NodeAddress * destNodeId, NodeAddress * destAddr, BOOL * isDestMulticast) Parameters:
node

Application input parsing API. Parses the source and destination strings.At the same time validates those strings for multicast address.

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr destString destNodeId

- A pointer to NodeAddress. - The destination string. - A pointer to NodeAddress.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

destAddr

- A pointer to NodeAddress. - Pointer to multicast checking flag.

isDestMulticast

Returns:
void

- None

APP_ParsingSourceAndDestString

void APP_ParsingSourceAndDestString (Node * node, const char * inputString, const char * sourceString, NodeAddress * sourceNodeId, NodeAddress * sourceAddr, const char * destString, NodeAddress * destNodeId, NodeAddress * destAddr, DestinationType * destType) Parameters:
node

API to parse the input source and destination strings read from the *.app file.At the same time checks and fills the destination type parameter.

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr destString destNodeId destAddr destType

- A pointer to NodeAddress. - The destination string. - A pointer to NodeAddress.

- A pointer to NodeAddress. - A pointer to Destinationtype.

Returns:
void

- None

APP_ParsingSourceAndDestString

void APP_ParsingSourceAndDestString (Node * node, const char * inputString, const char * sourceString, NodeId * sourceNodeId, Address * sourceAddr, const char * destString, NodeId * destNodeId, Address * destAddr, DestinationType * destType) Parameters:
node

API to parse the input source and destination strings read from the *.app file. At the same time checks and fills the destination type parameter.

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr destString destNodeId

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

- A pointer to NodeAddress. - The destination string. - A pointer to NodeAddress.

APP_UTIL

destAddr destType

- A pointer to NodeAddress. - A pointer to DestinationType.

Returns:
void

- None

APP_RegisterNewApp

AppInfo* APP_RegisterNewApp (Node* node, AppType appType, void * dataPtr, short myPort) Parameters:

Also inserts the port number being used for this app in the port table.

node

- node that is registering the application. - application type - pointer to the data space for this app

appType dataPtr myPort

- port number to be inserted in the port table

Returns:
AppInfo*

- pointer to the new AppInfo data structure

APP_IsFreePort

BOOL APP_IsFreePort (Node* node, short portNumber) Parameters:

node

- node that is checking it's port table - port number to check

portNumber

Returns:
BOOL

- indicates if the port is free

APP_GetFreePort

short APP_GetFreePort (Node* node) Parameters:

node

- node that is requesting a free port

Returns:
short

- returns a free port

APP_InserInPortTable

void APP_InserInPortTable (Node* node, AppType appType, short myPort) Parameters:

node

- node that needs to be insert in port table - application running at the port

appType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

myPort

- port number to check

Returns:
void

- None

APP_GetProtocolType

short APP_GetProtocolType (Node* node, Message* msg) Parameters:

node msg

- node that received the message

- pointer to the message received

Returns:
short

- protocol which will receive the message

APP_AssignTos

BOOL APP_AssignTos (char array tosString, char array tosValString, unsigned * tosVal) Parameters:

Application input parsing API. Parses the tos string and tos value strings.At the same time validates those strings for proper ranges.

tosString

- The tos string. - The tos value string.

tosValString tosVal

- A pointer to equivalent 8-bit TOS value.

Returns:
BOOL

- None

APP_UdpCreateNewHeaderVirtualDataWithPriority

Message* APP_UdpCreateNewHeaderVirtualDataWithPriority (Node * node, AppType appType, NodeAddress sourceAddr, short sourcePort, NodeAddress destAddr, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol) Parameters:
node

Allocate header + virtual data with specified priority and send to UDP. Generally used with messenger app.

- node that is sending the data. - type of application data - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr header

- the destination node Id data

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

- priority of data.

APP_UTIL

traceProtocol

- specify the type of application

Returns:
Message*

- Pointer to allocated message structure

APP_UdpCreateNewHeaderVirtualDataWithPriority

Message* APP_UdpCreateNewHeaderVirtualDataWithPriority (Node * node, AppType appType, Address sourceAddr, short sourcePort, Address destAddr, char* header, int headerSize, int payloadSize, TosType priority, TraceProtocolType traceProtocol) Parameters:
node

Allocate header + virtual data with specified priority and send to UDP. Generally used with messenger app.

- node that is sending the data. - type of application data - the source sending the data. - the application source port.

appType

sourceAddr sourcePort destAddr header

- the destination node Id data

- header of the payload. - size of the header. - size of the data in bytes.

headerSize

payloadSize priority

- priority of data. - specify the type of application

traceProtocol

Returns:
Message*

- Pointer to allocated message structure

APP_UnregisterApp

void APP_UnregisterApp (Node* node, void * dataPtr, bool freeData) Parameters:

Remove an application from list of apps on this node.

node

- node that is unregistering the application. - pointer to the data space for this app. - if true, free (via MEM_free) the dataPtr

dataPtr

freeData

Returns:
void

- None

APP_UnregisterApp

void APP_UnregisterApp (Node* node, AppType appType, void * dataPtr, short myPort) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

Also Remove the port number being used for this app in the port table.

node

- node that is registering the application. - application type - pointer to the data space for this app

appType dataPtr myPort

- port number to be inserted in the port table

Returns:
void

- None

APP_IsFreePort

BOOL APP_IsFreePort (Node* node, short portNumber) Parameters:

node

- node that is checking it's port table. - port number to check.

portNumber

Returns:
BOOL

- indicates if the port is free.

APP_RemoveFromPortTable

void APP_RemoveFromPortTable (Node* node, short myPort) Parameters:

node

- node that needs to be remove from port table - port number to check

myPort

Returns:
void

- None

APP_MdpLayerInit

void. APP_MdpLayerInit (Node* node, Address clientAddr, Address serverAddr, Int32 sourcePort, AppType appType, BOOL isProfileNameSet, char* profileName, Int32 uniqueId, NodeInput* nodeInput, Int32 destPort, BOOL destIsUnicast) Parameters:
node

- specify node that received the message. - specify address of the sender node. - specify address of the receiver. - specify source port of the sender.

clientAddr serverAddr sourcePort appType

- specify application type for which MDP layer - specify whether MDP profile is defined.

isProfileNameSet profileName
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

- specify the profile name if "isProfileNameSet"

APP_UTIL

uniqueId

- specify unique id for MDP. Default value is -1. - specify nodeinput. Default value is NULL.

nodeInput destPort

- specify destination port of the receiver. - specify whether dest address is unicast address

destIsUnicast

Returns:
void.

- None

APP_MdpLayerInitForOtherPartitionNodes

void. APP_MdpLayerInitForOtherPartitionNodes (Node* node, NodeInput* nodeInput, Address* destAddr, BOOL isUnicast) Parameters:

. which the calling node exists.

node

- specify node that received the message. - specify nodeinput.

nodeInput destAddr

- specify the multicast destination address. - specify whether application is unicast or multicast.

isUnicast

Returns:
void.

- None

APP_MdpQueueDataObject

void. APP_MdpQueueDataObject (Node* node, Address localAddr, Address remoteAddr, Int32 uniqueId, Int32 itemSize, char* payload, Int32 virtualSize, Message* theMsg, BOOL isFromAppForward) Parameters:
node

- specify node that received the message. - specify address of the sender node. - specify address of the receiver.

localAddr

remoteAddr uniqueId itemSize payload

- specify unique id for MDP. - specify the complete item size

- specify the payload for the item. - specify the virtual size of the item

virtualSize theMsg

- pointer to the received message. - will TRUE only when packet is queued from

isFromAppForward

Returns:
void.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

- None APP_MdpNotifyLastDataObject void. APP_MdpNotifyLastDataObject (Node* node, Address localAddr, Address remoteAddr, Int32 uniqueId) Parameters:
node

- specify node that received the message. - specify address of the sender node. - specify address of the receiver.

localAddr

remoteAddr uniqueId

- specify unique id for MDP.

Returns:
void.

- None

APP_ReportStatsDbReceiveEvent

SequenceNumber APP_ReportStatsDbReceiveEvent (Node* node, Message* msg, SequenceNumber** seqCache, Int64 seqNo, clocktype delay, clocktype jitter, int size, int numRcvd, AppMsgStatus msgStatus) Parameters:

Report receive event to StatsDB app event table This function will check duplicate and out of order msgs

node msg

- Pointer to a node who recieves the msg

- The received message or fragment - Pointer to the sequence number cache

seqCache seqNo delay

- Sequence number of the message or fragment - Delay of the message/fragment - Smoothed jitter of the received message

jitter size

- Size of msg/fragment to be report to db - # of msgs/frags received so far - This is for performance optimization. If

numRcvd

msgStatus

Returns:
SequenceNumber

- Status or out of order or new

Contact EXATA Support for questions pertaining to the EXATA API Reference. This document is confidential and proprietary. It may not be reproduced or distributed without the expressed written consent of Scalable Network Technologies.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APP_UTIL

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APP_UTIL.html[5/24/2011 12:32:23 PM]

APPLICATION LAYER

EXata 2.2 API Specification

APPLICATION LAYER
This file describes data structures and functions used by the Application Layer. Constant / Data Structure Summary Type
CONSTANT

Name
APP_DEFAULT_TOS

Application default tos value

CONSTANT APP_MAX_DATA_SIZE

Maximum size of data unit

CONSTANT DEFAULT_APP_QUEUE_SIZE

Default size of Application layer queue (in byte)

CONSTANT PORT_TABLE_HASH_SIZE

Prime number indicating port table size

CONSTANT MAC_LINK16_FRAG_SIZE

Maximum fragment size supported by LINK16 MAC protocol. For Link16, it seems the fragment size should be 8 * 9 bytes = 72 bytes
CONSTANT MAC_DEFAULT_INTERFACE

Default interface of MAC layer. ASSUMPTION :: Source and Destination node must have only one interface with TADIL network.
ENUMERATION AppType

Enumerates the type of application protocol

STRUCT Link16GatewayData

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APPLICATION LAYER.html[5/24/2011 12:32:32 PM]

APPLICATION LAYER

Store Link16/IP gateway forwarding table

STRUCT AppInfo

Information relevant to specific app layer protocol

STRUCT PortInfo

Store port related information

STRUCT AppMultimedia

Store multimedia signalling related information

STRUCT AppData

Details of application data structure in node structure

STRUCT AppTimer

Timer structure used by applications

Function / Macro Summary Return Type

void

Summary
InitiateConnectionType(Node* node, void* voip)

Multimedia callback funtion to open request for a TCP connection from the initiating terminal
void TerminateConnectionType(Node* node, void* voip)

Multimedia callback funtion to close TCP connection as requested by VOIP application

BOOL IsHostCallingType(Node* node)

Multimedia callback funtion to check whether node is in initiator mode

BOOL IsHostCalledType(Node* node)

Multimedia callback funtion to check whether node is in receiver mode

Enumerates the type of application protocol Link16GatewayData

Structure

Store Link16/IP gateway forwarding table AppInfo

Structure

Information relevant to specific app layer protocol PortInfo

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APPLICATION LAYER.html[5/24/2011 12:32:32 PM]

APPLICATION LAYER

node

- Pointer to the node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APPLICATION LAYER.html[5/24/2011 12:32:32 PM]

APPLICATION LAYER

Returns:
BOOL

- TRUE if the node is initiator, FALSE otherwise

IsHostCalledType

BOOL IsHostCalledType (Node* node) Parameters:

Multimedia callback funtion to check whether node is in receiver mode

node

- Pointer to the node

Returns:
BOOL

- TRUE if the node is receiver, FALSE otherwise

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/APPLICATION LAYER.html[5/24/2011 12:32:32 PM]

BUFFER

EXata 2.2 API Specification

BUFFER
This file describes data structures and functions to implement buffers. Constant / Data Structure Summary Type
STRUCT

Name
DataBuffer

structure for the data buffer

STRUCT ReassemblyBuffer

Format for the Reassembly buffer

STRUCT PacketBuffer

structure for the packet buffer

Function / Macro Summary Return Type

MACRO

Summary
BUFFER_GetCurrentSize(x)

Returns the current size of the buffer

MACRO BUFFER_GetMaxSize(x)

Returns maximum allowable size of the buffer

MACRO BUFFER_GetData(x)

Returns a pointer to the data in the buffer

MACRO BUFFER_GetAnticipatedSize(x)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

Returns the intial size of the buffer

MACRO BUFFER_SetCurrentSize(x,y)

Sets current size of the buffer

MACRO BUFFER_GetFreeSpace(x)

Get free space available in the buffer

MACRO BUFFER_ReturnTop(x)

Returns top of the buffer

MACRO BUFFER_NumberOfBlocks(X)

Returns the no. of blocks in the buffer

void BUFFER_InitializeDataBuffer(DataBuffer* buffer, int size)

Initializing Data buffer. Keeping in mind that buffer will be initialized once and the guess for initial size is a good one. For all the other manipulation of the buffer will try to allocate in the initial if not asked to increase size and this size will remain until end of program for re-using unless the buffer is closed completely.
void BUFFER_AddSpaceToDataBuffer(DataBuffer* buffer, int size)

Adding memory space to the buffer

void BUFFER_ClearDataFromDataBuffer(DataBuffer* buffer, char * startLocation, int size, BOOL destroy)

clear data from the buffer(already used portion of buffer Not any unused portion unless u clear till end)
void BUFFER_DestroyDataBuffer(DataBuffer* buffer)

To Destroy a buffer
void BUFFER_AddDataToDataBuffer(DataBuffer* buffer, char * data, int size)

Add data to databuffer

void BUFFER_RemoveDataFromDataBuffer(DataBuffer* buffer, char* startLocation, int size)

To remove data from the data buffer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

void

InitializeReassemblyBuffer(ReassemblyBuffer* buffer, int size)

Initialize Reassembly buffer

void BUFFER_AddDataToAssemblyBuffer(ReassemblyBuffer* buffer, char* data, int size, BOOL allowOverflow)

Appending data to the reassembly buffer

void BUFFER_ClearAssemblyBuffer(ReassemblyBuffer* buffer, int max, BOOL setSize)

clear the buffer

void BUFFER_SetAnticipatedSizeForAssemblyBuffer(ReassemblyBuffer* buffer, int size)

To set the anticipated size of the assemblyBuffer

PacketBuffer * BUFFER_AllocatePacketBuffer(int initialSize, int anticipatedHeaderMax, BOOL allowOverflow, char ** dataPtr)

To allocate packet buffer

PacketBuffer * BUFFER_AllocatePacketBufferWithInitialHeader(int initialSize, int initialHeaderSize, int anticipatedHeaderMax, BOOL allowOverflow, char ** dataPtr, char ** headerPtr)

To allocate buffer with Intial header

void BUFFER_AddHeaderToPacketBuffer(PacketBuffer* buffer, int headerSize, char** headerPtr)

To add header to buffer

void BUFFER_RemoveHeaderFromPacketBuffer(PacketBuffer* buffer, int headerSize, char** dataPtr)

To remove header from packet buffer

void BUFFER_ClearPacketBufferData(PacketBuffer* buffer)

To clear data from current buffer

void BUFFER_FreePacketBuffer(PacketBuffer* buffer)

Free the packet buffer passed as argument

void BUFFER_ConcatenatePacketBuffer(const PacketBuffer* source, PacketBuffer* dest)

Add useful contents of source buffer as header to to the destination buffer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

Constant / Data Structure Detail

Structure

DataBuffer

Structure

structure for the data buffer ReassemblyBuffer

Structure

Format for the Reassembly buffer PacketBuffer

structure for the packet buffer

Function / Macro Detail Function / Macro BUFFER_GetCurrentSize(x) Format Returns the current size of the buffer

BUFFER_GetMaxSize(x)

Returns maximum allowable size of the buffer

BUFFER_GetData(x)

Returns a pointer to the data in the buffer

BUFFER_GetAnticipatedSize(x)

Returns the intial size of the buffer

BUFFER_SetCurrentSize(x,y)

Sets current size of the buffer

BUFFER_GetFreeSpace(x)

Get free space available in the buffer

BUFFER_ReturnTop(x)

Returns top of the buffer

BUFFER_NumberOfBlocks(X)

Returns the no. of blocks in the buffer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

BUFFER_InitializeDataBuffer

void BUFFER_InitializeDataBuffer (DataBuffer* buffer, int size) Parameters:

buffer size

- buffer to be intialized

- intial size of the buffer

Returns:
void

- None

void BUFFER_AddSpaceToDataBuffer (DataBuffer* buffer, int size) Parameters:

Adding memory space to the buffer

buffer size

- buffer to which to add space

- size to be added

Returns:
void

- None

BUFFER_ClearDataFromDataBuffer

void BUFFER_ClearDataFromDataBuffer (DataBuffer* buffer, char * startLocation, int size, BOOL destroy) Parameters:

clear data from the buffer(already used portion of buffer Not any unused portion unless u clear till end)

buffer

- buffer from which data is cleared - starting location

startLocation size

- intial size of the buffer - destroy or not

destroy

Returns:
void

- None

BUFFER_DestroyDataBuffer

void BUFFER_DestroyDataBuffer (DataBuffer* buffer) Parameters:

To Destroy a buffer

buffer

- buffer to be destroyed

Returns:
void

- None

BUFFER_AddDataToDataBuffer

void BUFFER_AddDataToDataBuffer (DataBuffer* buffer, char * data, int size) Parameters:

Add data to databuffer

buffer

- buffer to which data is added

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

data size

- pointer to data that is added - initial size of the buffer

Returns:
void

- None

BUFFER_RemoveDataFromDataBuffer

void BUFFER_RemoveDataFromDataBuffer (DataBuffer* buffer, char* startLocation, int size) Parameters:

To remove data from the data buffer

buffer

- buffer from which data is to be removed - starting location from whcih data is removed

startLocation size

- size of the buffer

Returns:
void

- None

InitializeReassemblyBuffer

void InitializeReassemblyBuffer (ReassemblyBuffer* buffer, int size) Parameters:

Initialize Reassembly buffer

buffer size

- ReassemblyBuffer to be initialized

- maximum allowable size of the buffer

Returns:
void

- None

BUFFER_AddDataToAssemblyBuffer

void BUFFER_AddDataToAssemblyBuffer (ReassemblyBuffer* buffer, char* data, int size, BOOL allowOverflow) Parameters:

Appending data to the reassembly buffer

buffer data size

- Pointer to ReassemblyBuffer

- data to be added - size of the data - To allow overflow or not

PacketBuffer * BUFFER_AllocatePacketBufferWithInitialHeader (int initialSize, int initialHeaderSize, int anticipatedHeaderMax, BOOL allowOverflow, char ** dataPtr, char ** headerPtr) Parameters:

To allocate buffer with Intial header

initialSize

- intial buffer size - initial header size - expected max header size

initialHeaderSize

anticipatedHeaderMax allowOverflow dataPtr

- if overflow is allowed

- pointer to array - pointer to array

headerPtr
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

BUFFER

Returns:
PacketBuffer *

- Pointer to packetbuffer

BUFFER_AddHeaderToPacketBuffer

void BUFFER_AddHeaderToPacketBuffer (PacketBuffer* buffer, int headerSize, char** headerPtr) Parameters:

To add header to buffer

buffer

- Pointer to PacketBuffer - size of header

headerSize headerPtr

- Pointer to an array of strings

Returns:
void

- None

BUFFER_RemoveHeaderFromPacketBuffer

void BUFFER_RemoveHeaderFromPacketBuffer (PacketBuffer* buffer, int headerSize, char** dataPtr) Parameters:

To remove header from packet buffer

buffer

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/BUFFER.html[5/24/2011 12:32:49 PM]

CIRCULAR-BUFFER

EXata 2.2 API Specification

CIRCULAR-BUFFER
This file describes data structures and functions used for circular buffer implementation. Constant / Data Structure Summary Type
CONSTANT

Name
CIR_BUF_SIZE

Default Circular Buffer Size

ENUMERATION

Type of Circular Buffer Operation

ENUMERATION

Type of Wrap operation

Function / Macro Summary Return Type

bool

Summary
CircularBuffer.incPos(Int32 increment, Int32 operation)

increment read/write position based on operation

None CircularBuffer.CircularBuffer()

Constructor
None CircularBuffer.CircularBuffer(Int32 queueSize)

Constructor
None CircularBuffer.CircularBuffer(unsigned short index)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CIRCULAR-BUFFER

Constructor
None CircularBuffer.CircularBuffer(unsigned short index, Int32 queueSize)

Constructor
Node CircularBuffer.~CircularBuffer()

Destructor
bool CircularBuffer.create(Int32 queueSize)

Memory allocation for Circular Buffer

void CircularBuffer.release(void )

To free the allocated memory

void CircularBuffer.reset(void )

reset position and wrap values

bool CircularBuffer.getCount(Int32& count, Int32 operation)

gets the number of bytes to read

Int32 CircularBuffer.lengthToEnd(Int32 operation)

get the circular buffer's allocated size

bool CircularBuffer.readWithCount(unsigned char* data, Int32& length)

Read data from Buffer and pass the length of data read
bool CircularBuffer.readFromBuffer(unsigned char* data, Int32 length, bool noIncrement)

Reading the required no. of bytes from the circular buffer

bool CircularBuffer.write(unsigned char* data, Int32 length)

Write to the circular buffer

bool CircularBuffer.read(unsigned char* buffer)

To Read data from Buffer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CIRCULAR-BUFFER

Int32

CircularBuffer.getIndex(Int32 operation)

get the circular buffer's allocated size

Int32 CircularBuffer.getCirBufSize(void none)

get the circular buffer's allocated size

unsigned short CircularBuffer.getIndex(void none)

get the circular buffer's unique index

Constant / Data Structure Detail

Constant

CIR_BUF_SIZE 256

Default Circular Buffer Size Enumeration Type of Circular Buffer Operation Enumeration Type of Wrap operation

Function / Macro Detail Function / Macro CircularBuffer.incPos Format bool CircularBuffer.incPos (Int32 increment, Int32 operation) Parameters: increment read/write position based on operation
increment operation

- How much will be incremented - Type of Operation (Read or Write )

Returns:
bool

- Successful or not

CircularBuffer.CircularBuffer

None CircularBuffer.CircularBuffer ()

Constructor

index

- Circular Buffer Index - Size of the queue

queueSize

Returns:
None

- None

CircularBuffer.~CircularBuffer

Node CircularBuffer.~CircularBuffer () Parameters:

Destructor

Returns:
Node

- None

CircularBuffer.create

bool CircularBuffer.create (Int32 queueSize) Parameters:

Memory allocation for Circular Buffer

queueSize

- Size of queue

Returns:
bool

- Successful or not

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CIRCULAR-BUFFER

CircularBuffer.release

void CircularBuffer.release (void ) Parameters:

To free the allocated memory

- None Returns:
void

- None

CircularBuffer.reset

void CircularBuffer.reset (void ) Parameters:

reset position and wrap values

- None Returns:
void

- None

CircularBuffer.getCount

bool CircularBuffer.getCount (Int32& count, Int32 operation) Parameters:

gets the number of bytes to read

count

- the parameter to be filled up - Type of Operation (Read or Write)

operation

Returns:
bool

- successful or not

CircularBuffer.lengthToEnd

Int32 CircularBuffer.lengthToEnd (Int32 operation) Parameters:

get the circular buffer's allocated size

operation

- Read or Write Operation

Returns:
Int32

- Total length of data to be read

CircularBuffer.readWithCount

bool CircularBuffer.readWithCount (unsigned char* data, Int32& length) Parameters:

Read data from Buffer and pass the length of data read

data

- Container to which data will be read - length of data read

length

Returns:
bool

- Successful or not

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CIRCULAR-BUFFER

CircularBuffer.readFromBuffer

bool CircularBuffer.readFromBuffer (unsigned char* data, Int32 length, bool noIncrement) Parameters:

Reading the required no. of bytes from the circular buffer

data

- Container to which data will be read - length of data to be read - Whether the read pointer is to be incremented or not

length

noIncrement

Returns:
bool

- successful or not

CircularBuffer.write

bool CircularBuffer.write (unsigned char* data, Int32 length) Parameters:

Write to the circular buffer

data

- Container to which data will be written - Length of data to be written

length

Returns:
bool

- successful or not

CircularBuffer.read

bool CircularBuffer.read (unsigned char* buffer) Parameters:

To Read data from Buffer

buffer

- Container to which data will be read

Returns:
bool

- Succesful or not

CircularBuffer.getIndex

Int32 CircularBuffer.getIndex (Int32 operation) Parameters:

get the circular buffer's allocated size

operation

- Read or Write Operation

Returns:
Int32

- Current operation Position

CircularBuffer.getCirBufSize

Int32 CircularBuffer.getCirBufSize (void none) Parameters:

get the circular buffer's allocated size

none

- None

Returns:
Int32

- circular buffer's allocated size

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CIRCULAR-BUFFER

CircularBuffer.getIndex

unsigned short CircularBuffer.getIndex (void none) Parameters:

get the circular buffer's unique index

none

- None

Returns:
unsigned short

- unique index

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CIRCULAR-BUFFER.html[5/24/2011 12:33:07 PM]

CLOCK

EXata 2.2 API Specification

CLOCK
This file describes data structures and functions used for time-related operations. Constant / Data Structure Summary Type
CONSTANT

Name
CLOCKTYPE_MAX

CLOCKTYPE_MAX is the maximum value of clocktype. This value can be anything as long as it is less than or equal to the maximum value of the type which is typedefed to clocktype. Users can simulate the model up to CLOCKTYPE_MAX - 1.
CONSTANT NANO_SECOND

Defined as basic unit of clocktype

CONSTANT MICRO_SECOND

Defined as 1000 times the basic unit of clocktype

CONSTANT MILLI_SECOND

unit of time equal to 1000 times MICRO_SECOND

CONSTANT SECOND

simulation unit of time =1000 times MILLI_SECOND

CONSTANT MINUTE

unit of simulation time = 60 times SECOND

CONSTANT HOUR

unit of simulation time = 60 times MINUTE

CONSTANT DAY

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

CLOCK

unit of simulation time = 24 times HOUR

CONSTANT PROCESS_IMMEDIATELY

Used to prioratize a process

Function / Macro Summary Return Type

MACRO

Summary
ctoa

like sprintf, prints a clocktype to a string

MACRO atoc

like atoi or atof, converts a string to a clocktype

MACRO getSimTime(node)

To get the simulation time of a node

MACRO getSimStartTime(node)

To get the simulation start time of a node

MACRO TIME_getSimTime(node)

Gets current simulation time of a node

clocktype TIME_ConvertToClock(char* buf)

Read the string in "buf" and provide the corresponding clocktype value for the string using the following conversions: NS - nanoseconds MS - milli-seconds S - seconds (default if no specification) H - hours D - days
void TIME_PrintClockInSecond(clocktype clock, char * stringInSecond)

Print a clocktype value in second.The result is copied to string in Seconds

void TIME_PrintClockInSecond(clocktype clock, char * stringInSecond, Node * node)

Print a clocktype value in second.The result is copied to string in Seconds

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

CLOCK

void

TIME_PrintClockInSecond(clocktype clock, char * stringInSecond, PartitionData * partition)

Print a clocktype value in second.The result is copied to string in Seconds

clocktype TIME_ReturnMaxSimClock(Node* node)

Return the maximum simulation clock

clocktype TIME_ReturnStartSimClock(Node* node)

Return the simulation start clock

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

CLOCK

Constant

HOUR (60 * MINUTE)

Constant

unit of simulation time = 60 times MINUTE DAY (24 * HOUR)

Constant

unit of simulation time = 24 times HOUR PROCESS_IMMEDIATELY 0

Used to prioratize a process

Function / Macro Detail Function / Macro ctoa Format like sprintf, prints a clocktype to a string

atoc

like atoi or atof, converts a string to a clocktype

getSimTime(node)

To get the simulation time of a node

getSimStartTime(node)

To get the simulation start time of a node

TIME_getSimTime(node)

Gets current simulation time of a node

TIME_ConvertToClock

clocktype TIME_ConvertToClock (char* buf) Parameters:

buf

- The time string

Returns:
clocktype

- Time in clocktype

void TIME_PrintClockInSecond (clocktype clock, char * stringInSecond) Parameters:

Print a clocktype value in second.The result is copied to string in Seconds

clock

- Time in clocktype

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

CLOCK

stringInSecond

- string containing time in seconds

Returns:
void

- None

TIME_PrintClockInSecond

void TIME_PrintClockInSecond (clocktype clock, char * stringInSecond, Node * node) Parameters:

Print a clocktype value in second.The result is copied to string in Seconds

clock

- Time in clocktype - string containing time in seconds

stringInSecond node

- Input node

Returns:
void

- None

TIME_PrintClockInSecond

void TIME_PrintClockInSecond (clocktype clock, char * stringInSecond, PartitionData * partition) Parameters:

Print a clocktype value in second.The result is copied to string in Seconds

clock

- Time in clocktype - string containing time in seconds

stringInSecond partition

- Input partition

Returns:
void

- None

TIME_ReturnMaxSimClock

clocktype TIME_ReturnMaxSimClock (Node* node) Parameters:

Return the maximum simulation clock

node

- Input node

Returns:
clocktype

- Returns maximum simulation time

TIME_ReturnStartSimClock

clocktype TIME_ReturnStartSimClock (Node* node) Parameters:

Return the simulation start clock

node

- Input node

Returns:
clocktype

- Returns simulation start time

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

CLOCK

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/CLOCK.html[5/24/2011 12:33:17 PM]

COORDINATES

EXata 2.2 API Specification

COORDINATES
This file describes data structures and functions used for coordinates-related operations. Constant / Data Structure Summary Type
CONSTANT

Name
PI

Defines the value of constant PI

CONSTANT ANGLE_RESOLUTION

Defines ANGLE_RESOLUTION
CONSTANT IN_RADIAN

Defines the constant IN_RADIAN

CONSTANT EARTH_RADIUS

Defines the above constant EARTH_RADIUS

ENUMERATION EarthRepresentationType

Defines the type of Earth that is represented Replaces coordinate_system_type

ENUMERATION CoordinateRepresentationType

Defines the coordinate system that a coordinate is given in reference to

ENUMERATION coordinate_system_type

Defines the type of coordinate system

STRUCT cartesian_coordinates

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

Defines the three cartesian coordinates

STRUCT latlonalt_coordinates

Defines the three latlonalt coordinates

STRUCT common_coordinates

Defines the three common coordinates

STRUCT Coordinates

Defines coordinates
STRUCT Orientation

Defines the orientation structure

Function / Macro Summary Return Type

MACRO

Summary
MAX(X, Y)

Finds the maximum of two entries

MACRO MIN(X, Y)

Finds the minimum of two entries

MACRO COORD_ShortestPropagationDelay(dist)

Calculate the shortest propagation delay. Shortest delay is assumed with light speed. Actual delay could be longer if propagation medium is not eletromegnatic waves, such as acoustic wave.
BOOL COORD_CoordinatesAreTheSame(const Coordinates c1, const Coordinates c2)

To compare two coordinates and determine if they are the same

BOOL COORD_OrientationsAreTheSame(const Orientation o1, const Orientation o2)

To compare two coordinates and determine if they have the same orientation
static int COORD_NormalizeAzimuthAngle(int angle)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

To normalize the azimuth angle

static int COORD_NormalizeElevationAngle(int angle)

To normalize the elevation angle

static int COORD_NormalizeAngleIndex(int angleIndex, int angleResolution)

To normalize the angleIndex

BOOL COORD_CalcDistance(int coordinateSystemType, const Coordinates* position1, const Coordinates* position2, CoordinateType distance)

To calculate the distance between two nodes(points) given the coordinateSystemType and the coordinates of the two points
static void COORD_CalcDistanceAndAngle(int coordinateSystemType, const position1, const position2, double* distance, Orientation* DOA1, Orientation* DOA2)

To calculate the Distance and Angle

static void COORD_ChangeCoordinateSystem(const CoordinateRepresentationType source_type, const Coordinates* const source, const CoordinateRepresentationType target_type, Coordinates* const target)

Re-calculate coordinate in a new coordinate system

static void COORD_ChangeCoordinateSystem(const Coordinates* const source, const CoordinateRepresentationType target_type, Coordinates* const target)

Re-calculate coordinate in a new coordinate system

static void COORD_GeodeticToGeocentricCartesian(const Coordinates* const source, Coordinates* const target)

Convert coordinate from GEODETIC to GEOCENTRIC_CARTESIAN

static void COORD_GeocentricCartesianToGeodetic(const Coordinates* const source, Coordinates* const target)

Convert coordinate from GEOCENTRIC_CARTESIAN to GEODETIC

static void COORD_JGISToGeodetic(const Coordinates* const source, Coordinates* const target)

Convert coordinate from JGIS to GEODETIC

static void COORD_JGISToUnreferencedCartesian(const Coordinates* const source, Coordinates* const target)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

Convert coordinate from JGIS to UNREFERENCED_CARTESIAN

static void COORD_ConvertToCoordinates(char* buf, Coordinates* coordinates)

Read the string in "buf" and provide the corresponding coordinates for the string.
static void COORD_MapCoordinateSystemToType(int coordinateSystem, Coordinates* coordinates)

Set coordinates type field (CoordinateRepresentationType) based on the user-provided coordinate system (coordinate_system_type)
static void COORD_NormalizeLongitude(Coordinates* coordinates)

Correct the longitude value to between -180 and 180. This function assumes the coordinate system is LLA.
bool COORD_PointWithinRange(int coordinateSystemType, Coordinates* sw, Coordinates* ne, Coordinates* point)

Is the point within the given range. Assume -90 <= lat <= 90 and -180 <= long <= 180 for all inputs.
bool COORD_RegionsOverlap(int coordinateSystemType, Coordinates* sw1, Coordinates* ne1, Coordinates* sw2, Coordinates* ne2)

COORDINATES

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

Function / Macro MAX(X, Y)

Format Finds the maximum of two entries

MIN(X, Y)

Finds the minimum of two entries

COORD_ShortestPropagationDelay(dist)

Calculate the shortest propagation delay. Shortest delay is assumed with light speed. Actual delay could be longer if propagation medium is not eletromegnatic waves, such as acoustic wave. BOOL COORD_CoordinatesAreTheSame (const Coordinates c1, const Coordinates c2) Parameters:

COORD_CoordinatesAreTheSame

To compare two coordinates and determine if they are the same

c1 c2

- coordinates of a point - coordinates of a point

Returns:
BOOL

- whether the points are the same

COORD_OrientationsAreTheSame

BOOL COORD_OrientationsAreTheSame (const Orientation o1, const Orientation o2) Parameters:

To compare two coordinates and determine if they have the same orientation

o1 o2

- orientation of a point - orientation of a point

Returns:
BOOL

- whether the points have the same orientation

COORD_NormalizeAzimuthAngle

static int COORD_NormalizeAzimuthAngle (int angle) Parameters:

To normalize the azimuth angle

angle

- azimuth angle

Returns:
static int

- None

COORD_NormalizeElevationAngle

static int COORD_NormalizeElevationAngle (int angle) Parameters:

To normalize the elevation angle

angle

- Angle of elevation

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

static int

- None

COORD_NormalizeAngleIndex

static int COORD_NormalizeAngleIndex (int angleIndex, int angleResolution) Parameters:

To normalize the angleIndex

angleIndex

- angleIndex - angleResolution

angleResolution

Returns:
static int

- Return normalized angleIndex

COORD_CalcDistance

BOOL COORD_CalcDistance (int coordinateSystemType, const Coordinates* position1, const Coordinates* position2, CoordinateType distance) Parameters:

To calculate the distance between two nodes(points) given the coordinateSystemType and the coordinates of the two points

coordinateSystemType position1 position2 distance

- type of coordinate system

- coordinates of a point - coordinates of a point

- distance between two points

Returns:
BOOL

- whether the distance is calculated from position1 to position2

COORD_CalcDistanceAndAngle

static void COORD_CalcDistanceAndAngle (int coordinateSystemType, const position1, const position2, double* distance, Orientation* DOA1, Orientation* DOA2) Parameters:

To calculate the Distance and Angle

coordinateSystemType position1 position2 distance DOA1 DOA2

- coordinateSystem Type

- Coordinates* - Coordinates*

- distance

- DOA 1 - DOA 2

Returns:
static void

- None

COORD_ChangeCoordinateSystem

static void COORD_JGISToGeodetic (const Coordinates* const source, Coordinates* const target)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

static void COORD_MapCoordinateSystemToType (int coordinateSystem, Coordinates* coordinates) Parameters:

Set coordinates type field (CoordinateRepresentationType) based on the user-provided coordinate system (coordinate_system_type)

coordinateSystem coordinates

- enum value indicating coordinate system

- Pointer to the coordinates

Returns:
static void

- None

COORD_NormalizeLongitude

static void COORD_NormalizeLongitude (Coordinates* coordinates) Parameters:

Correct the longitude value to between -180 and 180. This function assumes the coordinate system is LLA.

coordinates

- Pointer to the coordinates

Returns:
static void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

COORD_PointWithinRange

bool COORD_PointWithinRange (int coordinateSystemType, Coordinates* sw, Coordinates* ne, Coordinates* point) Parameters:

Is the point within the given range. Assume 90 <= lat <= 90 and -180 <= long <= 180 for all inputs.

coordinateSystemType sw ne

- Cartesian or Geodetic

- Pointer to the SW corner (0,0) if Cartesian - Pointer to the NE corner (dimensions if Cartesian) - Pointer to the coordinates

point

Returns:
bool

- True if within range

COORD_RegionsOverlap

bool COORD_RegionsOverlap (int coordinateSystemType, Coordinates* sw1, Coordinates* ne1, Coordinates* sw2, Coordinates* ne2) Parameters:

Determine whether the given regions overlap at all.

coordinateSystemType sw1 ne1 sw2 ne2

- Cartesian or Geodetic

- Pointer to the SW corner of the first region - Pointer to the NE corner of the first region - Pointer to the SW corner of the second region - Pointer to the NE corner of the second region

Returns:
bool

- true if the regions overlap at all.

COORD_LongitudeDelta

void COORD_LongitudeDelta (CoordinateType long1, CoordinateType long2) Parameters:

Convenience function for geodetic that, given two longitudes, returns the difference (in degrees) in the shorter direction.

long1 long2

- coordinate 1 - coordinate 2

Returns:
void

- None

COORD_PrintCoordinates

void COORD_PrintCoordinates (int coordinateSystemType, Coordinates* point) Parameters:

Prints the coordinates in a human readable format.

coordinateSystemType point

- Cartesian or Geodetic

- Pointer to the coordinates

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

COORDINATES

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/COORDINATES.html[5/24/2011 12:33:26 PM]

ERROR

EXata 2.2 API Specification

ERROR
This file defines data structures and functions used in error-handling. Constant / Data Structure Summary Type
CONSTANT

Name
ERROR_ASSERTION

Defines the ERROR_ASSERTION constant

CONSTANT ERROR_ERROR

Defines the ERROR_ERROR constant

CONSTANT ERROR_WARNING

Defines the ERROR_WARNING constant

Function / Macro Summary Return Type

MACRO

Summary
ERROR_Assert(expr, str)

May be used in place of assert,to include an error message

MACRO assert(expr)

In DEBUG mode assert macro will be replaced by ERROR_WriteError with ERROR_ASSERTION type
MACRO ERROR_ReportError(str)

Function call used to report an error condition in QualNet, and notify GUI of such.
MACRO ERROR_ReportWarning(str)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ERROR.html[5/24/2011 12:33:34 PM]

ERROR

Function call used to report a recoverable error condition. This macro in turns calls ERROR_WriteError with ERROR_WARNING type. It reports a warning message in QualNet, and notify GUI of such
extern BOOL ERROR_WriteError(int type, char* condition, char* msg, char* file, int lineno)

Function call used to report failed assertions, errors, and warnings, and notify the GUI of such. The user should not call this function directly, but should use one of the previously defined macros.
void ERROR_InstallHandler(int type, char* condition, char* msg, char* file, int lineno, QErrorHandler functionPointer)

Function used to register a callback function. The callback function will be invoked by ERROR_ when ERROR_WriteError () is invoked. For example - logging error messages into a log file or send the error messages to another application (e.g. to the Qualnet IDE that started the simulation.)
void ERROR_ReportMissingAddon(const char* model, const char* addon)

Reports an error when user attempts to use a model that hasn't been installed, either because the customer hasn't purchased that feature, or they haven't downloaded and compiled it.
void ERROR_ReportMissingInterface(const char* model, const char* iface)

Reports an error when user attempts to use a model that hasn't been installed, either because the customer hasn't purchased that feature, or they haven't downloaded and compiled it.

Constant / Data Structure Detail

Constant

ERROR_ASSERTION 0

Constant

Defines the ERROR_ASSERTION constant ERROR_ERROR 1

Constant

Defines the ERROR_ERROR constant ERROR_WARNING 2

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ERROR.html[5/24/2011 12:33:34 PM]

ERROR

Defines the ERROR_WARNING constant

Function / Macro Detail Function / Macro ERROR_Assert(expr, str) Format May be used in place of assert,to include an error message

assert(expr)

In DEBUG mode assert macro will be replaced by ERROR_WriteError with ERROR_ASSERTION type

ERROR_ReportError(str)

Function call used to report an error condition in QualNet, and notify GUI of such.

ERROR_ReportWarning(str)

Function call used to report a recoverable error condition. This macro in turns calls ERROR_WriteError with ERROR_WARNING type. It reports a warning message in QualNet, and notify GUI of such extern BOOL ERROR_WriteError (int type, char* condition, char* msg, char* file, int lineno) Parameters:

ERROR_WriteError

Function call used to report failed assertions, errors, and warnings, and notify the GUI of such. The user should not call this function directly, but should use one of the previously defined macros.

type

- assertion, error, or warning - a string representing the failed boolean condition

condition msg

- an error message - the file name in which the assertion failed - the line on which the assertion failed.

file

lineno

Returns:
extern BOOL

- None

ERROR_InstallHandler

void ERROR_InstallHandler (int type, char* condition, char* msg, char* file, int lineno, QErrorHandler functionPointer) Parameters:

type

- assertion, error, or warning - a string representing the failed boolean condition

condition msg

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/ERROR.html[5/24/2011 12:33:34 PM]

EXTERNAL

EXata 2.2 API Specification

EXTERNAL
This file defines the generic interface to external modules. Constant / Data Structure Summary Type
CONSTANT

Name
EXTERNAL_MAX_TIME

The maximum possible time

CONSTANT EXTERNAL_NUM_CPU_TIMING_INTERVAL_GUESSES

The number of guesses to make for the cpu timing interval

CONSTANT EXTERNAL_MAPPING_TABLE_SIZE

The size of an interface's mapping hash table

CONSTANT EXTERNAL_NUM_FUNCTIONS

The number of functions an interface may implement

ENUMERATION ExternalInterfaceType

Enumeration of different types of external interfaces

STRUCT EXTERNAL_ThreadedMessage

A struct containing data needed to send a message from an external thread to the main thread.
STRUCT EXTERNAL_ThreadedForwarded

A struct containing data needed to send a forwarded packet from the main thread to an external forward function
STRUCT EXTERNAL_Mapping

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

A linked list node containing one mapping. The key may be of any size, specified by keySize. The value the key maps to is a pointer to some piece of data. It is assumed that whoever created the mapping will know what to do with the pointer. The user will not use this structure directly.
STRUCT EXTERNAL_MobilityEvent

A linked list of mobility events

STRUCT EXTERNAL_MobilityEventBuffer

A buffer containing all mobility events yet to be added to the simulation.

STRUCT EXTERNAL_InterfaceList

A list containing all of the registered external entities

STRUCT EXTERNAL_Interface

The information pertaining to one external interface

Function / Macro Summary Return Type

EXTERNAL_Interface *

Summary
EXTERNAL_RegisterExternalInterface(EXTERNAL_InterfaceList* list, char* name, EXTERNAL_PerformanceParameters params)

This function will register a new external interface with QualNet and create the necessary data structures. This function must be called before any other function that requires an EXTERNAL_Interface* argument.
EXTERNAL_Interface * EXTERNAL_RegisterExternalInterface(EXTERNAL_InterfaceList* list, char* name, EXTERNAL_PerformanceParameters params, ExternalInterfaceType type)

This function is an overloaded variation. for registering a new external interface with QualNet
void EXTERNAL_RegisterFunction(EXTERNAL_Interface* iface, EXTERNAL_FunctionType type, EXTERNAL function)

Register a new function for an interface.

void EXTERNAL_SetTimeManagementRealTime(EXTERNAL_Interface* iface, clocktype lookahead)

Turns time management on and specifies the lookahead value. The lookahead value may be changed later by calling EXTERNAL_ChangeRealTimeLookahead().
void EXTERNAL_ChangeRealTimeLookahead(EXTERNAL_Interface* iface, clocktype lookahead)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Modifies the lookahead value. Must be called after EXTERNAL_SetTimeManagementRealTime(). May be called during the simulation.
void EXTERNAL_InitializeWarmupParams(EXTERNAL_Interface* iface, NodeInput* nodeInput)

void

EXTERNAL_SetWarmupTime(EXTERNAL_Interface* iface, clocktype warmup)

Sets this interface's warmup time. The actual warmup time used is the maximum of all interface's. The default is no warmup time (warmup == -1). This function must be called before or during the initialize nodes step. It will have no effect during the simulation.
void EXTERNAL_BeginWarmup(EXTERNAL_Interface* iface)

Each interface that calls EXTERNAL_SetWarmupTime must call EXTERNAL_BeginWarmup when it is ready to enter warmup time.
clocktype EXTERNAL_QueryWarmupTime(EXTERNAL_Interface* iface)

Get the warmup time for the entire simulation. Interfaces should use this function to test when warmup time is over.
BOOL EXTERNAL_IsInWarmup(EXTERNAL_Interface* iface)

Check if QualNet is in the warmup phase

BOOL EXTERNAL_IsInWarmup(PartitionData* partitionData)

Check if QualNet is in the warmup phase

void EXTERNAL_Pause(EXTERNAL_Interface* iface)

Pause every interface. Only usable when running in real-time.

void EXTERNAL_Resume(EXTERNAL_Interface* iface)

Resume every interface. Only usable when running in real-time, and after calling pause.
clocktype EXTERNAL_QueryExternalTime(EXTERNAL_Interface* iface)

This function will return the External Time of an external interface

clocktype EXTERNAL_QuerySimulationTime(EXTERNAL_Interface* iface)

This function will return the Simulation Time

void EXTERNAL_Sleep(clocktype amount)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

This function will sleep for a minimum amount of time as indicated by the amount parameter. Depending on which platform it is called on the amount of time spent sleeping could be greater.
void EXTERNAL_SetReceiveDelay(EXTERNAL_Interface* iface, clocktype delay)

This function will set the minimum delay between two consecutive calls to the receive function. The time used is the simulation time.
void EXTERNAL_SendMessage(EXTERNAL_Interface* iface, Node* node, Message* msg, clocktype timestamp)

This function will send a message from the external interface. This function is thread-safe.
void EXTERNAL_ForwardData(EXTERNAL_Interface* iface, Node* node, void* forwardData, int forwardSize, EXTERNAL_ForwardData_ReceiverOpt FwdReceiverOpt)

Send data back to the external source with no time stamp. The user defined Forward function will receive this message and process it. This will handle threading issues if necessary.
void EXTERNAL_RemoteForwardData(EXTERNAL_Interface* iface, Node* node, void* forwardData, int forwardSize, int partitionId)

Send data back to the external source with no time stamp. This function is similar to EXTERNAL_ForwardData, except that this function can forward the message to and external interface on a different partition.
void EXTERNAL_ForwardDataTimeStamped(EXTERNAL_Interface* iface, Node* node, Message* message, clocktype timestamp)

Send data in the form of a message back to the external source with a time stamp. The user defined Forward function will receive this message and process it. This will handle threading issues if necessary.
void EXTERNAL_UserFunctionRegistration(EXTERNAL_InterfaceList * list, NodeInput* nodeInput)

This function will give a convenient place for users to add their function registration code. This is the only part of the External Interface API code that the user is expected to modify.
void EXTERNAL_InitializeInterface(EXTERNAL_Interface* iface)

This function will initialize an external interface

void EXTERNAL_FinalizeExternalInterface(EXTERNAL_Interface* iface)

This function will free an external interface, as well as call the finalize function registered by EXTERNAL_RegisterFinalizeFunction()
void EXTERNAL_InitializeInterfaceList(EXTERNAL_InterfaceList* list, PartitionData* partition)

This function will initialize an external interface list

void EXTERNAL_Bootstrap(int argc, char* argv [])

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

This function will be called early in the simulation initialization process (after MPI_Init(), but before partitions are created, and before EXTERNAL_InitializeInterfaceList (). In a shared parallel simulation the threads for partitions won't be created yet. This function handles the mini-configuration file conversion, and make sures that if simProps needs to change it is changed and then a broadcast message is sent to other partitions.
void EXTERNAL_FinalizeInterfaceList(EXTERNAL_InterfaceList* list)

This function will finalize all ExternalInterfaces in the list, as well as the list itself
EXTERNAL_Interface* EXTERNAL_GetInterfaceByName(EXTERNAL_InterfaceList* list, char* name)

This function will search an interface list for an interface with the given name
void EXTERNAL_CallInitializeFunctions(EXTERNAL_InterfaceList* list, NodeInput* nodeInput)

This function will call all initialize functions

void EXTERNAL_CallInitializeNodesFunctions(EXTERNAL_InterfaceList* list, NodeInput* nodeInput)

This function will call all intialize nodes functions

void EXTERNAL_StartThreads(EXTERNAL_InterfaceList* list)

This function will start the receive/forward threads for all threaded interfaces. Called after EXTERNAL_CallInitializeNodesFunctions.
clocktype EXTERNAL_CalculateMinSimulationHorizon(EXTERNAL_InterfaceList* list, clocktype now)

This function will call all simulation horizon functions to determine how far into the future the simulation can run. An individual simulation horizon function will only be called if the current time (now) is >= that interface's current horizon.
void EXTERNAL_CallReceiveFunctions(EXTERNAL_InterfaceList* list)

This function will call all receive function that were not started in a thread
void EXTERNAL_CallFinalizeFunctions(EXTERNAL_InterfaceList* list)

This function will call all finalize functions

void EXTERNAL_InitializeExternalInterfaces(partitionData* partitionData)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Function used to initialize a generic interface to an external source of messages, e.g. an HLA federate. Called before nodes are created.
void EXTERNAL_PostInitialize(partitionData* partitionData)

Function used to initialize a generic interface to an external source of messages, e.g. an HLA federate.Called after nodes are created. The developer can use either this function, the preceding one or both.
void EXTERNAL_GetExternalMessages(partitionData* partitionData, clocktype nextInternalEventTime)

Function used to retrieve messages from a remote source, such as a DIS gateway or HLA federation. Called before events at time X are executed. Many events at time X may be executed before the next call
void EXTERNAL_Finalize(partitionData* partitionData)

Shuts down interfaces to external simulators

void EXTERNAL_SetActive(partitionData* partitionData)

Sets isActive parameter based on interface registration

void EXTERNAL_DeactivateInterface(EXTERNAL_Interface* ifaceToDeactivate)

Remove the indicated interface for the list of currently activateed interfaces.
void EXTERNAL_ProcessEvent(Node* node, Message* msg)

EXTERNAL_MAPPING_TABLE_SIZE 31

The information pertaining to one external interface

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Function / Macro Detail Function / Macro EXTERNAL_RegisterExternalInterface Format EXTERNAL_Interface * EXTERNAL_RegisterExternalInterface (EXTERNAL_InterfaceList* list, char* name, EXTERNAL_PerformanceParameters params) Parameters: This function will register a new external interface with QualNet and create the necessary data structures. This function must be called before any other function that requires an EXTERNAL_Interface* argument.
list name

- The list of external interfaces - The name of the external interface. - The performance parameters

params

Returns:
EXTERNAL_Interface *

- A pointer to the newly registered external interface

EXTERNAL_RegisterExternalInterface

EXTERNAL_Interface * EXTERNAL_RegisterExternalInterface (EXTERNAL_InterfaceList* list, char* name, EXTERNAL_PerformanceParameters params, ExternalInterfaceType type) Parameters:

This function is an overloaded variation. for registering a new external interface with QualNet

list name

- The list of external interfaces - The name of the external interface. - The performance parameters

params type

- PartitionData's interfaceTable will be

Returns:
EXTERNAL_Interface *

- A pointer to the newly registered external interface

EXTERNAL_RegisterFunction

void EXTERNAL_RegisterFunction (EXTERNAL_Interface* iface, EXTERNAL_FunctionType type, EXTERNAL function) Parameters:

Register a new function for an interface.

iface type

- The external interface

- the type of function - Function pointer to be called

function

Returns:
void

- None

EXTERNAL_SetTimeManagementRealTime

void EXTERNAL_SetTimeManagementRealTime (EXTERNAL_Interface* iface, clocktype lookahead)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Parameters: Turns time management on and specifies the lookahead value. The lookahead value may be changed later by calling EXTERNAL_ChangeRealTimeLookahead().
iface

- The external interface - How far into the future the simulation is

lookahead

Returns:
void

- None

EXTERNAL_ChangeRealTimeLookahead

void EXTERNAL_ChangeRealTimeLookahead (EXTERNAL_Interface* iface, clocktype lookahead) Parameters:

Modifies the lookahead value. Must be called after EXTERNAL_SetTimeManagementRealTime(). May be called during the simulation.

iface

- The external interface - The new lookahead value

lookahead

Returns:
void

- None

EXTERNAL_InitializeWarmupParams

void EXTERNAL_InitializeWarmupParams (EXTERNAL_Interface* iface, NodeInput* nodeInput) Parameters:

iface

- The external interface - The configuration file.

nodeInput

Returns:
void

- None

EXTERNAL_SetWarmupTime

void EXTERNAL_SetWarmupTime (EXTERNAL_Interface* iface, clocktype warmup) Parameters:

iface

- The external interface - The warmup time for this interface

warmup

Returns:
void

- None

void EXTERNAL_BeginWarmup (EXTERNAL_Interface* iface) Parameters:

Each interface that calls EXTERNAL_SetWarmupTime must call EXTERNAL_BeginWarmup when it is ready to enter warmup time.

iface

- The external interface

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

EXTERNAL_QueryWarmupTime

clocktype EXTERNAL_QueryWarmupTime (EXTERNAL_Interface* iface) Parameters:

Get the warmup time for the entire simulation. Interfaces should use this function to test when warmup time is over.

iface

- The external interface

Returns:
clocktype

- The inclusive end of warmup time. -1 if no warmup time.

EXTERNAL_IsInWarmup

BOOL EXTERNAL_IsInWarmup (EXTERNAL_Interface* iface) Parameters:

Check if QualNet is in the warmup phase

iface

- The external interface

Returns: - TRUE if in warmup, FALSE if not This is now a wrapper function ONLY. It passes a pointer to partition data. We overload this function in order to check if simulator is in warm-up phase even when we do not have access to External interface
BOOL

EXTERNAL_IsInWarmup

BOOL EXTERNAL_IsInWarmup (PartitionData* partitionData) Parameters:

Check if QualNet is in the warmup phase

partitionData

- pointer to partition's data structure

Returns:
BOOL

- TRUE if in warmup, FALSE if not

EXTERNAL_Pause

void EXTERNAL_Pause (EXTERNAL_Interface* iface) Parameters:

Pause every interface. Only usable when running in real-time.

iface

- The external interface

Returns:
void

- None

EXTERNAL_Resume

void EXTERNAL_Resume (EXTERNAL_Interface* iface) Parameters:

Resume every interface. Only usable when running in real-time, and after calling pause.

iface

- The external interface

Returns:
void

- None

EXTERNAL_QueryExternalTime

clocktype EXTERNAL_QueryExternalTime (EXTERNAL_Interface* iface)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Parameters: This function will return the External Time of an external interface
iface

- The external interface

Returns:
clocktype

- The External Time. Returns EXTERNAL_MAX_TIME if no time function is defined.

EXTERNAL_QuerySimulationTime

clocktype EXTERNAL_QuerySimulationTime (EXTERNAL_Interface* iface) Parameters:

This function will return the Simulation Time

iface

- The external interface

Returns:
clocktype

- The Simulation Time

EXTERNAL_Sleep

void EXTERNAL_Sleep (clocktype amount) Parameters:

amount

- The amount of time to sleep

Returns:
void

- None

void EXTERNAL_SetReceiveDelay (EXTERNAL_Interface* iface, clocktype delay) Parameters:

This function will set the minimum delay between two consecutive calls to the receive function. The time used is the simulation time.

iface delay

- The external interface - The minimum delay

Returns:
void

- None

EXTERNAL_SendMessage

void EXTERNAL_SendMessage (EXTERNAL_Interface* iface, Node* node, Message* msg, clocktype timestamp) Parameters:

This function will send a message from the external interface. This function is thread-safe.

iface node msg

- The external interface

- Node sending the message

- The message to send - The timestamp for this message. Since this message is

timestamp

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

void

- None

EXTERNAL_ForwardData

void EXTERNAL_ForwardData (EXTERNAL_Interface* iface, Node* node, void* forwardData, int forwardSize, EXTERNAL_ForwardData_ReceiverOpt FwdReceiverOpt) Parameters:

Send data back to the external source with no time stamp. The user defined Forward function will receive this message and process it. This will handle threading issues if necessary.

iface node

- The external interface

- The node that is forwarding the data - The data to forward - The size of the data to forward - Whether to store the

forwardData forwardSize

FwdReceiverOpt

Returns:
void

- None

EXTERNAL_RemoteForwardData

void EXTERNAL_RemoteForwardData (EXTERNAL_Interface* iface, Node* node, void* forwardData, int forwardSize, int partitionId) Parameters:

iface node

- The external interface

partition

Returns:
void

- None

EXTERNAL_Bootstrap

void EXTERNAL_Bootstrap (int argc, char* argv []) Parameters:

This function will be called early in the simulation initialization process (after MPI_Init(), but before partitions are created, and before EXTERNAL_InitializeInterfaceList (). In

argc

- The command line argument count - The command line arguments

argv []

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

a shared parallel simulation the threads for partitions won't be created yet.
void

- None

EXTERNAL_PreBootstrap

void EXTERNAL_PreBootstrap (int argc, char* argv []) Parameters:

argc

- The command line argument count - The command line arguments

argv []

Returns:
void

- None

void EXTERNAL_FinalizeInterfaceList (EXTERNAL_InterfaceList* list) Parameters:

This function will finalize all ExternalInterfaces in the list, as well as the list itself

list

- The external interface list

Returns:
void

- None

EXTERNAL_GetInterfaceByName

EXTERNAL_Interface* EXTERNAL_GetInterfaceByName (EXTERNAL_InterfaceList* list, char* name) Parameters:

This function will search an interface list for an interface with the given name

list name

- The external interface list - The interface's name

Returns:
EXTERNAL_Interface*

- The interface, NULL if not found

EXTERNAL_CallInitializeFunctions

void EXTERNAL_CallInitializeFunctions (EXTERNAL_InterfaceList* list, NodeInput* nodeInput) Parameters:

This function will call all initialize functions

list

- The list of external interfaces - The input configuration file

nodeInput

Returns:
void

- None

EXTERNAL_CallInitializeNodesFunctions

void EXTERNAL_CallInitializeNodesFunctions (EXTERNAL_InterfaceList* list, NodeInput* nodeInput)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Parameters: This function will call all intialize nodes functions

list

- The list of external interfaces - The input configuration file

nodeInput

Returns:
void

- None

EXTERNAL_StartThreads

void EXTERNAL_StartThreads (EXTERNAL_InterfaceList* list) Parameters:

This function will start the receive/forward threads for all threaded interfaces. Called after EXTERNAL_CallInitializeNodesFunctions.

list

- The list of external interfaces

Returns:
void

- None

EXTERNAL_CalculateMinSimulationHorizon

clocktype EXTERNAL_CalculateMinSimulationHorizon (EXTERNAL_InterfaceList* list, clocktype now) Parameters:

list now

- The list of external interfaces

- The current time

Returns:
clocktype

- The minimum Simulation Horizon, or EXTERNAL_MAX_TIME if no horizon.

EXTERNAL_CallReceiveFunctions

void EXTERNAL_CallReceiveFunctions (EXTERNAL_InterfaceList* list) Parameters:

This function will call all receive function that were not started in a thread

list

- The list of external interfaces

Returns:
void

- None

EXTERNAL_CallFinalizeFunctions

void EXTERNAL_CallFinalizeFunctions (EXTERNAL_InterfaceList* list) Parameters:

This function will call all finalize functions

list

- The list of external interfaces

Returns:
void

- None

EXTERNAL_InitializeExternalInterfaces

void EXTERNAL_InitializeExternalInterfaces (partitionData* partitionData) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

Function used to initialize a generic interface to an external source of messages, e.g. an HLA federate. Called before nodes are created.

partitionData

- pointer to data for this partition

Returns:
void

Shuts down interfaces to external simulators

partitionData

- pointer to data for this partition

Returns:
void

- None

EXTERNAL_SetActive

void EXTERNAL_SetActive (partitionData* partitionData) Parameters:

Sets isActive parameter based on interface registration

partitionData

- pointer to data for this partition

Returns:
void

- None

EXTERNAL_DeactivateInterface

void EXTERNAL_DeactivateInterface (EXTERNAL_Interface* ifaceToDeactivate) Parameters:

Remove the indicated interface for the list of

ifaceToDeactivate

- Pointer to the interface

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL

currently activateed interfaces. Returns:

void

- None

EXTERNAL_ProcessEvent

void EXTERNAL_ProcessEvent (Node* node, Message* msg) Parameters:

Process events meant for external code.

node msg

- Pointer to node data structure.

- Message to be processed.

Returns:
void

- None

GetNextInternalEventTime

clocktype GetNextInternalEventTime (PartitionData* partitionData) Parameters:

Get the next internal event on the given partition. This includes both regular events and mobility events.

partitionData

- Pointer to the partition

Returns:
clocktype

- The next internal event

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL.html[5/24/2011 12:33:43 PM]

EXTERNAL_SOCKET

EXata 2.2 API Specification

EXTERNAL_SOCKET
This file describes utilities for managing socket connections to external programs. Constant / Data Structure Summary Type
CONSTANT

Name
EXTERNAL_DEFAULT_VAR_ARRAY_SIZE

The default size of a VarArray

CONSTANT THREADED_BUFFER_SIZE

The thread buffer size

ENUMERATION EXTERNAL_SocketErrorType

A listing of error types that could occur.

STRUCT EXTERNAL_VarArray

A variable sized array. This structure is primarily used to assemble data to be sent on a socket connection.
STRUCT EXTERNAL_Socket

The socket data structure

Function / Macro Summary Return Type

void

Summary
EXTERNAL_VarArrayInit(EXTERNAL_VarArray* array, unsigned int size)

This function will initialize a VarArray and allocate memory for the array. When the array is finished being used, call EXTERNAL_VarArrayFree to free the memory.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

void

EXTERNAL_VarArrayAccomodateSize(EXTERNAL_VarArray* array, unsigned int size)

This function will increase the maximum size of the VarArray so that it can contain at least "size" bytes.
void EXTERNAL_VarArrayAppendData(EXTERNAL_VarArray* array, char* data, unsigned int size)

This function will add data to the end of the VarArray. The size of the VarArray will be increased if necessary.
void EXTERNAL_VarArrayConcatString(EXTERNAL_VarArray* array, char* string)

This function will add a string to the end of the VarArray including the terminating NULL character. This function ASSUMES that the previous data in the VarArray is also a string -- ie, several bytes of data terminated with a NULL character. If this is not the case then the function EXTERNAL_VarArrayAppendData should be used instead.
void EXTERNAL_VarArrayFree(EXTERNAL_VarArray* array)

This function will free all memory allocated to the VarArray

void EXTERNAL_hton(void* ptr, unsigned size)

Convert data from host byte order to network byte order

void EXTERNAL_ntoh(void* ptr, unsigned size)

Convert data from network byte order to host byte order

void EXTERNAL_swapBitfield(void* ptr, unsigned size)

void

EXTERNAL_SocketInit(EXTERNAL_Socket* socket)

Initialize a socket. Must be called before all other socket API calls on the individual socket.
EXTERNAL_SocketErrorType EXTERNAL_SocketInitUDP(EXTERNAL_Socket* socket)

Initialize a UDP socket. Must be called before all other socket API calls on the individual socket.
BOOL EXTERNAL_SocketValid(EXTERNAL_Socket* socket)

Check if a socket connection is valid and no errors have occurred.

EXTERNAL_SocketErrorType EXTERNAL_SocketListen(EXTERNAL_Socket* listenSocket, int port, EXTERNAL_Socket* connectSocket)

Listen and accept a connections on a socket. This function is a wrapper for EXTERNAL_SocketInitListen and EXTERNAL_SocketAccept.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

EXTERNAL_SocketErrorType

EXTERNAL_SocketInitListen(EXTERNAL_Socket* listenSocket, int port)

Initialize an input socket and have it listen on the given port. Call EXTERNAL_SocketAccept to accept connections on the socket. Call EXTERNAL_SocketDataAvailable to see if there is an incoming connection that has not been accepted.
EXTERNAL_SocketErrorType EXTERNAL_SocketAccept(EXTERNAL_Socket* listenSocket, EXTERNAL_Socket* connectSocket)

Accept a connection on a listening socket. This operation may block if there is no incoming connection, use EXTERNAL_SocketDataAvailable to check if there is an incoming connection.
EXTERNAL_SocketErrorType EXTERNAL_SocketDataAvailable(EXTERNAL_Socket* s, BOOL* available)

Test if a socket has readable data. For a listening socket this will test for an incoming connection. For a data socket this will test if there is incoming data.
EXTERNAL_SocketErrorType EXTERNAL_SocketConnect(EXTERNAL_Socket* socket, char* address, int port, int maxAttempts)

Connect to a listening socket. The socket is set to non-blocking mode.

EXTERNAL_SocketErrorType EXTERNAL_SocketSend(EXTERNAL_Socket* socket, char* data, unsigned int size, BOOL block)

Send data on a connected socket. Since the socket is non-blocking, it is possible that the send would result in a block: If the "block" parameter is FALSE, then EXTERNAL_DataNotSent is returned, and no data is sent.
EXTERNAL_SocketErrorType EXTERNAL_SocketSend(EXTERNAL_Socket* socket, EXTERNAL_VarArray* data, BOOL block)

This is a wrapper for the above overloaded function.

EXTERNAL_SocketErrorType EXTERNAL_SocketRecv(EXTERNAL_Socket* socket, char* data, unsigned int size, unsigned int* size, BOOL block)

Receive data on a connected socket. Since the socket is non-blocking, it is possible that the send would result in a block: If the "block" parameter is FALSE, the "receiveSize" parameter will be set to the amount of data received before the blocking operation. This amount could be any value between 0 and size - 1.
EXTERNAL_SocketErrorType EXTERNAL_SocketClose(EXTERNAL_Socket* socket)

Close a socket. Must be called for each socket that is listening or connected.

Constant / Data Structure Detail

Constant

EXTERNAL_DEFAULT_VAR_ARRAY_SIZE 512

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

Constant

The default size of a VarArray THREADED_BUFFER_SIZE 2000000

Enumeration

The thread buffer size EXTERNAL_SocketErrorType

Structure

A listing of error types that could occur. EXTERNAL_VarArray

Structure

A variable sized array. This structure is primarily used to assemble data to be sent on a socket connection. EXTERNAL_Socket

The socket data structure

Function / Macro Detail Function / Macro EXTERNAL_VarArrayInit Format void EXTERNAL_VarArrayInit (EXTERNAL_VarArray* array, unsigned int size) Parameters: This function will initialize a VarArray and allocate memory for the array. When the array is finished being used, call EXTERNAL_VarArrayFree to free the memory.
array size

- Pointer to the uninitialized VarArray

- The initial size of the array in bytes . Defaults

Returns:
void

- None

EXTERNAL_VarArrayAccomodateSize

void EXTERNAL_VarArrayAccomodateSize (EXTERNAL_VarArray* array, unsigned int size) Parameters:

This function will increase the maximum size of the VarArray so that it can contain at least "size" bytes.

array size

- Pointer to the VarArray

- The new minimum size of the VarArray

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

EXTERNAL_VarArrayAppendData

void EXTERNAL_VarArrayAppendData (EXTERNAL_VarArray* array, char* data, unsigned int size) Parameters:

This function will add data to the end of the VarArray. The size of the VarArray will be increased if necessary.

array data size

- Pointer to the VarArray

- Pointer to the data to add - The size of the data to add

Returns:
void

- None

EXTERNAL_ntoh

void EXTERNAL_ntoh (void* ptr, unsigned size) Parameters:

Convert data from network byte order to host

ptr

- Pointer to the data

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

byte order
size

- Size of the data

Returns:
void

EXTERNAL_SocketInitUDP

EXTERNAL_SocketErrorType EXTERNAL_SocketInitUDP (EXTERNAL_Socket* socket) Parameters:

Initialize a UDP socket. Must be called before all other socket API calls on the individual socket.

socket

- Pointer to the socket

Returns:
EXTERNAL_SocketErrorType

- Error type

EXTERNAL_SocketValid

BOOL EXTERNAL_SocketValid (EXTERNAL_Socket* socket) Parameters:

Check if a socket connection is valid and no errors have occurred.

socket

- Pointer to the socket

Returns:
BOOL

- TRUE if valid, FALSE if closed or errors

EXTERNAL_SocketListen

EXTERNAL_SocketErrorType EXTERNAL_SocketListen (EXTERNAL_Socket* listenSocket, int port, EXTERNAL_Socket* connectSocket) Parameters:

Listen and accept a connections on a socket. This function is a wrapper for

listenSocket

- Pointer to the socket to listen on

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

EXTERNAL_SocketInitListen and EXTERNAL_SocketAccept.

port

- The port to listen on - Pointer to the socket that will

connectSocket

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketInitListen EXTERNAL_SocketErrorType EXTERNAL_SocketInitListen (EXTERNAL_Socket* listenSocket, int port) Parameters: Initialize an input socket and have it listen on the given port. Call EXTERNAL_SocketAccept to accept connections on the socket. Call EXTERNAL_SocketDataAvailable to see if there is an incoming connection that has not been accepted. EXTERNAL_SocketAccept
listenSocket port

- Pointer to the socket to listen on

- The port to listen on

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketErrorType EXTERNAL_SocketAccept (EXTERNAL_Socket* listenSocket, EXTERNAL_Socket* connectSocket) Parameters:

Accept a connection on a listening socket. This operation may block if there is no incoming connection, use EXTERNAL_SocketDataAvailable to check if there is an incoming connection.

listenSocket

- Pointer to the socket to listen on. - Pointer to the newly created socket

connectSocket

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketDataAvailable EXTERNAL_SocketErrorType EXTERNAL_SocketDataAvailable (EXTERNAL_Socket* s, BOOL* available) Parameters: Test if a socket has readable data. For a listening socket this will test for an incoming connection. For a data socket this will test if there is incoming data.
s

- Pointer to the socket - TRUE if data is available

available

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketConnect EXTERNAL_SocketErrorType EXTERNAL_SocketConnect (EXTERNAL_Socket* socket, char* address, int port, int maxAttempts) Parameters:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

Connect to a listening socket. The socket is set to non-blocking mode.

socket

- Pointer to the socket - String represent the address to connect to

address port

- The port to connect to - Number of times to attempt connecting before an

maxAttempts

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketSend EXTERNAL_SocketErrorType EXTERNAL_SocketSend (EXTERNAL_Socket* socket, char* data, unsigned int size, BOOL block) Parameters: Send data on a connected socket. Since the socket is non-blocking, it is possible that the send would result in a block: If the "block" parameter is FALSE, then EXTERNAL_DataNotSent is returned, and no data is sent.
socket data size

- Pointer to the socket

- Pointer to the data - Size of the data - If this call may block. Defaults to TRUE.

block

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketSend EXTERNAL_SocketErrorType EXTERNAL_SocketSend (EXTERNAL_Socket* socket, EXTERNAL_VarArray* data, BOOL block) Parameters: This is a wrapper for the above overloaded function.
socket data

- Pointer to the socket

- Pointer to the VarArray to send - If this call may block. Defaults to TRUE.

block

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketRecv EXTERNAL_SocketErrorType EXTERNAL_SocketRecv (EXTERNAL_Socket* socket, char* data, unsigned int size, unsigned int* size, BOOL block) Parameters: Receive data on a connected socket. Since the socket is non-blocking, it is possible that the send would result in a block: If the "block"
socket

- Pointer to the socket

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_SOCKET

parameter is FALSE, the "receiveSize" parameter will be set to the amount of data received before the blocking operation. This amount could be any value between 0 and size - 1.

data size size

- Pointer to the destination - The amount of data to receive in bytes - The number of bytes received. This could be less - TRUE if the call can block, FALSE if non-blocking.

block

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons. EXTERNAL_SocketClose EXTERNAL_SocketErrorType EXTERNAL_SocketClose (EXTERNAL_Socket* socket) Parameters: Close a socket. Must be called for each socket that is listening or connected.
socket

- Pointer to the socket

Returns:
EXTERNAL_SocketErrorType

- EXTERNAL_NoSocketError if successful, different error if not successful which could be

due to a number of reasons.

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_SOCKET.html[5/24/2011 12:33:54 PM]

EXTERNAL_UTILITIES

EXata 2.2 API Specification

EXTERNAL_UTILITIES
This file describes utilities for external interfaces. Constant / Data Structure Summary Type
ENUMERATION

Name
ExternalScheduleType

Enumeration of allowed scheduling operations - e.g. EXTERNAL_ActivateNode

STRUCT EXTERNAL_TreeNode

Structure of each node of a Splaytree

STRUCT EXTERNAL_Tree

Structure of a Splaytree
STRUCT EXTERNAL_ForwardInstantiate

Info field used for instantiating a forward app

STRUCT EXTERNAL_ForwardSendUdpData

Info field used for sending a UDP forward app

STRUCT EXTERNAL_ForwardSendTcpData

Info field used for sending a UDP forward app

STRUCT EXTERNAL_TableRecord

A record in the table. Contains a pointer value and a timestamp, as well as information for maintaining a linked list.
STRUCT EXTERNAL_SimulationDurationInfo

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

A duration of simulation time

STRUCT EXTERNAL_TableOverflow

A overflow record.
STRUCT EXTERNAL_Table

A table. Generally used for storing external packet data, but can be used for anything.
STRUCT EXTERNAL_NetworkLayerPacket

A packet that will be sent at the network layer. Created by EXTERNAL_SendDataNetworkLayer, sent by EXTERNAL_SendNetworkLayerPacket

Function / Macro Summary Return Type

void

Summary
EXTERNAL_TreeInitialize(EXTERNAL_Tree* tree, BOOL useStore, int maxStore)

To initialize the splaytree

void SCHED_SplayTreeInsert(EXTERNAL_Tree* tree, EXTERNAL_TreeNode* treeNode)

To insert a node into the Splaytree

void EXTERNAL_TreePeekMin(EXTERNAL_Tree* tree)

To look up a node in the Splaytree

void EXTERNAL_InitializeTable(EXTERNAL_Table* table, int size)

This function will initialize the table. The size parameter represents the number of records that will be allocated in one block.
void EXTERNAL_FinalizeTable(EXTERNAL_Table* table)

This function will finalize the table

EXTERNAL_TableRecord* EXTERNAL_GetUnusedRecord(EXTERNAL_Table* table)

This function will retrieve an unused record from the table. If the packet table is full it will allocate a new block of records. The user may fill in the record's contents. It will never return NULL.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

EXTERNAL_TableRecord*

EXTERNAL_GetEarliestRecord(EXTERNAL_Table* table)

This function will retrieve the earliest record in the table or NULL if the table is empty.
BOOL EXTERNAL_GetEarliestRecord(EXTERNAL_Table* table, char* data)

This function will check if a data pointer is still in the table.

EXTERNAL_TableRecord* EXTERNAL_FreeRecord(EXTERNAL_Table* table)

This function frees a record previously returned from EXTERNAL_GetUnusedRecord(). The memory contained in the data portion of the record is the user's responsiblity to free.
void EXTERNAL_SendDataAppLayerUDP(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* data, int dataSize, clocktype timestamp, AppType app, TraceProtocolType trace, TosType priority)

Sends data originating from the app layer using UDP. When the packet reaches its destination it will call the forward function of the external interface, if it exists.
void EXTERNAL_SendDataAppLayerUDP(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* header, int headerSize, int virtualDataSize, clocktype timestamp, AppType app, TraceProtocolType trace, TosType priority)

Sends virtual data originating from the app layer using UDP. When the packet reaches its destination it will call the forward forward function of the external interface, if it exists.
void EXTERNAL_SendDataAppLayerTCP(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* data, int dataSize, clocktype timestamp)

Sends data originating from the app layer using TCP. When the last byte of data reaches its destination it will call the forward function of the external interface, if it exists.
void EXTERNAL_SendDataNetworkLayer(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, clocktype timestamp)

Sends data originating from network layer. No provisions are made for handling this data once it enters the QualNet network. This is the responsibility of the external interface or protocols the data is sent to.
void EXTERNAL_SendDataNetworkLayerOnInterface(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, unsigned short identification, BOOL dontFragment, BOOL moreFragments, unsigned short fragmentOffset, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, int interfaceIndex, clocktype timestamp)

Sends data originating from network layer on a specific interface of the node. No provisions are made for handling this data once it enters the QualNet network. This is the responsibility of the external interface or protocols the data is sent to.
void EXTERNAL_SendVirtualDataNetworkLayer(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int dataSize, int virtualSize, clocktype timestamp)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

Sends data originating from network layer. No provisions are made for handling this data once it enters the QualNet network. This is the responsibility of the external interface or protocols the data is sent to.
void EXTERNAL_SendDataNetworkLayer(EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, unsigned short identification, BOOL dontFragment, BOOL moreFragments, unsigned short fragmentOffset, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, int ipHeaderLength, char* ipOptions, clocktype timestamp)

Sends the packet from EXTERNAL_SendDataNetworkLayer after some delay. This function should never be called directly.
void EXTERNAL_CreateMapping(EXTERNAL_Interface* iface, char* key, int keySize, char* value, int valueSize)

Creates a mapping between a key and a value. The key may be any value and any length, such as an IP address, a MAC address, or a generic string. The value may be anything and is the responsibility of the user. Memory will be allocated for the key and the value.
int EXTERNAL_ResolveMapping(EXTERNAL_Interface* iface, char* key, int keySize, char** value, int* valueSize)

Resolves a mapping created by EXTERNAL_CreateMapping. If it exists it is placed in the value and valueSize parameters and returns 0. The returned value will point to the memory block allocated by EXTERNAL_CreateMapping. If it does not exist it returns non-zero and the value and valueSize parameters are invalid.
int EXTERNAL_DeleteMapping(EXTERNAL_Interface* iface, char* key, int keySize)

Deletes a mapping created by EXTERNAL_CreateMapping.

void EXTERNAL_ActivateNode(EXTERNAL_Interface* iface, Node* node)

Activate a node so that it can begin processing events.

void EXTERNAL_DectivateNode(EXTERNAL_Interface* iface, Node* node)

Dectivate a node so that it stops processing events.

void EXTERNAL_PHY_SetTxPower(Node* node, int phyIndex, double newTxPower)

Just like PHY_SetTxPower (), but able to handle setting transmission power when node is owned by a remote partition. Change to TxPower will be scheduled as "best-effort" for remote nodes. The range of coordinate values depends on the terrain data.
void EXTERNAL_PHY_GetTxPower(Node* node, int phyIndex, double * txPowerPtr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

Just like PHY_GetTxPower (), but able to handle getting transmission power when node is owned by a remote partition.
void EXTERNAL_ChangeNodePosition(EXTERNAL_Interface* iface, Node* node, double c1, double c2, double c3)

Change the position of a node. This function will work using both coordinate systems. Orientation is not changed. Coordinate values are checked to be in the proper range, and are converted if they are not. The range of coordinate values depends on the terrain data.
void EXTERNAL_ChangeNodeOrientation(EXTERNAL_Interface* iface, Node* node, short azimuth, short elevation)

Change the orientation of a node. Position is not changed. Azimuth/elevation are checked to be in the proper range, and are converted if they are not.
void EXTERNAL_ChangeNodePositionAndOrientation(EXTERNAL_Interface* iface, Node* node, double c1, double c2, double c3, short azimuth, short elevation)

Change both the position and orientation of a node. This function will work using both coordinate systems. Coordinate values and Azimuth/elevation values are checked to be in the proper range, and are converted if they are not. The range of coordinate values depends on the terrain data.
void EXTERNAL_ChangeNodePositionOrientationAndSpeedAtTime(EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double c1, double c2, double c3, short azimuth, short elevation, double speed)

Change the position, orientation, and speed of a node at a user-specified time. This function will work using both coordinate systems. Coordinate values, azimuth/elevation, and speed values are checked to be in the proper range, and are converted if they are not. The range of coordinate values depends on the terrain data.
void EXTERNAL_ChangeNodePositionOrientationAndVelocityAtTime(EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double c1, double c2, double c3, short azimuth, short elevation, double speed, double c1Speed, double c2Speed, double c3Speed)

Update the position, orientation, and velocity vector of a node at a user-specified time. The velocity vector is expected to be in the same distance units used for the the position, per one second. The speed parameter must also be provided, accurate for the provided velocity vector, and always in meters per second. Coordinate values, azimuth/elevation, and speed values are checked to be in the proper range, and are converted if they are not. The range of coordinate values depends on the terrain data.
void EXTERNAL_ChangeNodePositionOrientationAndVelocityAtTime(EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double c1, double c2, double c3, short azimuth, short elevation, double c1Speed, double c2Speed, double c3Speed)

Update the position, orientation, and velocity vector of a node at a user-specified time. The velocity vector is expected to be in the same distance units used for the the position, per one second. Coordinate values, azimuth/elevation, and speed values are checked to be in the proper range, and are converted if they are not. The range of coordinate values depends on the terrain data.
void EXTERNAL_ChangeNodeVelocityAtTime(EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double speed, double c1Speed, double c2Speed, double c3Speed)

Update the velocity vector of a node at a user-specified time. The velocity vector is expected to be in the same distance units used for the terrain, per one second. The speed parameter must also be provided, accurate for the provided velocity vector, and always in meters per second.
void EXTERNAL_ChangeNodeVelocityAtTime(EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime,
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

double c1Speed, double c2Speed, double c3Speed)

Update the velocity vector of a node at a user-specified time. The velocity vector is expected to be in the same distance units used for the terrain, per one second.
BOOL EXTERNAL_ConfigStringPresent(NodeInput* nodeInput, char* string)

This function will check the config file for a string. Typically this is used during interface registration to see if the interface is turned on in the config file.
BOOL EXTERNAL_ConfigStringIsYes(NodeInput* nodeInput, char* string)

This function will check the config file for a string. Typically this is used during interface registration to see if the interface is turned on in the config file. Checks that the string is YES.
void EXTERNAL_MESSAGE_RemoteSend(EXTERNAL_Interface* iface, int destinationPartitionId, Message * msg, clocktype delay, ExternalScheduleType scheduling)

Send a message to the external interface on a different partition. This function makes it possible for your external interface to send a message to your external interface that is on on a different/remote partition. You will then need to add your message handler into the function EXTERNAL_ProcessEvent (). Lastly, you can request a best-effort delivery of your message to the remote external interface by passing in a delay value of 0 and a scheduling type of EXTERNAL_SCHEDULE_LOOSELY. Be aware that best-effort messages may be scheduled at slightly different simulation times each time your run your simulation. Further notes about scheduling. If your external event won't result in additional qualnet events, except those that will be scheduled after safe time, then you can use LOOSELY. If, your event is going to schedule additional qualnet event though, then you must use EXTERNAL_SCHEDULE_SAFE (so that the event is delayed to the next safe time). If you violate safe time you will get assertion failures for safe time of signal receive time.
void EXTERNAL_SetSimulationEndTime(partitionData* partitionData, clocktype endTime)

This function is a means to programatically set the end of the simulation. The endTime argument can be omitted, in which case the endTime is the current simulation time. If the requested time has already passed, the simulation will end as soon as possible.
clocktype EXTERNAL_QueryRealTime()

This function will return the wall clock time in the qualnet time format. NOTE: Interfaces that are running in real-time should not use this function to check the simulation time. The simulation time will not be the same as real time if the simulation was paused. Use the interface's time function instead.
clocktype EXTERNAL_QueryRealTime()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

This function will return the amount of Cpu time used by QualNet. The first call to this function will by an interface will return 0, and timing will begin from that point.
void EXTERNAL_Sleep(clocktype amount)

This function will sleep for a minimum amount of time as indicated by the amount parameter. Depending on which platform it is called on the amount of time spent sleeping could be greater.

Constant / Data Structure Detail

Enumeration

ExternalScheduleType

Structure

A record in the table. Contains a pointer value and a timestamp, as well as information for maintaining a linked list. EXTERNAL_SimulationDurationInfo

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

Structure

A duration of simulation time EXTERNAL_TableOverflow

Structure

A overflow record. EXTERNAL_Table

Structure

A table. Generally used for storing external packet data, but can be used for anything. EXTERNAL_NetworkLayerPacket

A packet that will be sent at the network layer. Created by EXTERNAL_SendDataNetworkLayer, sent by EXTERNAL_SendNetworkLayerPacket

Function / Macro Detail Function / Macro EXTERNAL_TreeInitialize Format void EXTERNAL_TreeInitialize (EXTERNAL_Tree* tree, BOOL useStore, int maxStore) Parameters: To initialize the splaytree
tree

- Pointer to the splaytree - Use Store - Max Store

useStore maxStore

Returns:
void

- None

SCHED_SplayTreeInsert

void SCHED_SplayTreeInsert (EXTERNAL_Tree* tree, EXTERNAL_TreeNode* treeNode) Parameters:

To insert a node into the Splaytree

tree

- Pointer to the splaytree - Pointer to the splayNode

treeNode

Returns:
void

- None

EXTERNAL_TreePeekMin

void EXTERNAL_TreePeekMin (EXTERNAL_Tree* tree) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

To look up a node in the Splaytree

tree

- Pointer to the splaytree

Returns:
void

- None

EXTERNAL_InitializeTable

void EXTERNAL_InitializeTable (EXTERNAL_Table* table, int size) Parameters:

This function will initialize the table. The size parameter represents the number of records that will be allocated in one block.

table size

- The table

- The size of the table

Returns:
void

- None

EXTERNAL_FinalizeTable

void EXTERNAL_FinalizeTable (EXTERNAL_Table* table) Parameters:

This function will finalize the table

table

- The table

Returns:
void

- None

EXTERNAL_GetUnusedRecord

EXTERNAL_TableRecord* EXTERNAL_GetUnusedRecord (EXTERNAL_Table* table) Parameters:

table

- The table

Returns:
EXTERNAL_TableRecord*

- The retrieved record

EXTERNAL_GetEarliestRecord

EXTERNAL_TableRecord* EXTERNAL_GetEarliestRecord (EXTERNAL_Table* table) Parameters:

This function will retrieve the earliest record in the table or NULL if the table is empty.

table

- The table

Returns:
EXTERNAL_TableRecord*

- The retrieved record

EXTERNAL_GetEarliestRecord

BOOL EXTERNAL_GetEarliestRecord (EXTERNAL_Table* table, char* data) Parameters:

This function will check if a data pointer is still in the table.

table

- The table

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

data

- The data to check for

Returns:
BOOL

- TRUE if it is in the table, FALSE if not

EXTERNAL_FreeRecord

EXTERNAL_TableRecord* EXTERNAL_FreeRecord (EXTERNAL_Table* table) Parameters:

This function frees a record previously returned from EXTERNAL_GetUnusedRecord(). The memory contained in the data portion of the record is the user's responsiblity to free.

table

- The table

Returns:
EXTERNAL_TableRecord*

- The retrieved record

EXTERNAL_SendDataAppLayerUDP

void EXTERNAL_SendDataAppLayerUDP (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* data, int dataSize, clocktype timestamp, AppType app, TraceProtocolType trace, TosType priority) Parameters:
iface from to

Sends data originating from the app layer using UDP. When the packet reaches its destination it will call the forward function of the external interface, if it exists.

- The external interface

- The address of the sending node

- The address of the receiving node - The data that is to be sent. This may be NULL if there - The size of the data - The time to send this message. Pass 0 to send

data

dataSize

timestamp app

- The application to send to, defaults to APP_FORWARD - The trace protocol, defaults to TRACE_FORWARD - The priority to send this message at

trace

priority

Returns:
void

- None

EXTERNAL_SendDataAppLayerUDP

void EXTERNAL_SendDataAppLayerUDP (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* header, int headerSize, int virtualDataSize, clocktype timestamp, AppType app, TraceProtocolType trace, TosType priority) Parameters:
iface from to

Sends virtual data originating from the app layer using UDP. When the packet reaches its destination it will call the forward forward function of the external interface, if it exists.

- The external interface

- The address of the sending node

- The address of the receiving node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

header

- The header that is to be sent. - The size of the header - The size of the virtual data

headerSize

virtualDataSize timestamp app

- The time to send this message. Pass 0 to send

- The application to send to, defaults to APP_FORWARD - The trace protocol, defaults to TRACE_FORWARD - The priority to send this message at. defaults to IPTOS_PREC_ROUTINE

trace

priority

Returns:
void

- None

EXTERNAL_SendDataAppLayerTCP

void EXTERNAL_SendDataAppLayerTCP (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress to, char* data, int dataSize, clocktype timestamp) Parameters:

Sends data originating from the app layer using TCP. When the last byte of data reaches its destination it will call the forward function of the external interface, if it exists.

iface from to

- The external interface

- The address of the sending node

- The address of the receiving node - The data that is to be sent. This may be NULL if there - The size of the data - The time to send this message. Pass 0 to send

data

dataSize

timestamp

Returns:
void

- None

EXTERNAL_SendDataNetworkLayer

void EXTERNAL_SendDataNetworkLayer (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, clocktype timestamp) Parameters:
iface from

- The external interface

- The address of the node that will send the - The IP address of the node originally - The address of the receiving node

srcAddr

destAddr tos

- The Type of Service field in the IP header

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

protocol ttl

- The protocol field in the IP header

- The Time to Live field in the IP header - The data that is to be sent. This should include - The size of the data

payload

payloadSize timestamp

- The time to send this packet. Pass 0 to send

Returns:
void

- None

EXTERNAL_SendDataNetworkLayerOnInterface

void EXTERNAL_SendDataNetworkLayerOnInterface (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, unsigned short identification, BOOL dontFragment, BOOL moreFragments, unsigned short fragmentOffset, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, int interfaceIndex, clocktype timestamp) Parameters:
iface from

- The external interface

- The address of the node that will send the - The IP address of the node originally - The address of the receiving node - The identification field in the IP

srcAddr

destAddr

identification dontFragment

- Whether to set the dont fragment bit in the IP - Whether to set the more fragments bit in the IP - The fragment offset field in the IP

moreFragments

fragmentOffset tos

- The Type of Service field in the IP header - The protocol field in the IP header

protocol ttl

- The Time to Live field in the IP header - The data that is to be sent. This should include - The size of the data - The interface index

payload

payloadSize

interfaceIndex timestamp

- The time to send this packet. Pass 0 to send

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

EXTERNAL_SendVirtualDataNetworkLayer

void EXTERNAL_SendVirtualDataNetworkLayer (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int dataSize, int virtualSize, clocktype timestamp) Parameters:
iface from

- The external interface

- The address of the node that will send the - The IP address of the node originally - The address of the receiving node

srcAddr

destAddr tos

- The Type of Service field in the IP header - The protocol field in the IP header

protocol ttl

- The Time to Live field in the IP header - The data that is to be sent. This should include - The size of the data - The size of the virtual data

payload

dataSize

virtualSize timestamp

- The time to send this packet. Pass 0 to send

Returns:
void

- None

EXTERNAL_SendDataNetworkLayer

void EXTERNAL_SendDataNetworkLayer (EXTERNAL_Interface* iface, NodeAddress from, NodeAddress srcAddr, NodeAddress destAddr, unsigned short identification, BOOL dontFragment, BOOL moreFragments, unsigned short fragmentOffset, TosType tos, unsigned char protocol, unsigned int ttl, char* payload, int payloadSize, int ipHeaderLength, char* ipOptions, clocktype timestamp) Parameters:
iface from

- The external interface

- The address of the node that will send the - The IP address of the node originally - The address of the receiving node - The identification field in the IP

srcAddr

destAddr

identification dontFragment

- Whether to set the dont fragment bit in the IP - Whether to set the more fragments bit in the IP - The fragment offset field in the IP

moreFragments

fragmentOffset

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

tos

- The Type of Service field in the IP header - The protocol field in the IP header

protocol ttl

- The Time to Live field in the IP header - The data that is to be sent. This should include - The size of the data - length of the IP Header including options if any

payload

payloadSize

ipHeaderLength ipOptions timestamp

- pointer to the IP Option. - The time to send this packet. Pass 0 to send

Returns:
void

- None

EXTERNAL_SendNetworkLayerPacket

void EXTERNAL_SendNetworkLayerPacket (Node* node, Message* msg) Parameters:

Sends the packet from EXTERNAL_SendDataNetworkLayer after some delay. This function should never be called directly.

node msg

- The node sending the packet

- The message

Returns:
void

- None

EXTERNAL_CreateMapping

void EXTERNAL_CreateMapping (EXTERNAL_Interface* iface, char* key, int keySize, char* value, int valueSize) Parameters:

iface key

- The external interface

- The address of the key - The size of the key in bytes

keySize value

- The address of what the value maps to - The size of the value in bytes

valueSize

Returns:
void

- None

EXTERNAL_ResolveMapping

int EXTERNAL_ResolveMapping (EXTERNAL_Interface* iface, char* key, int keySize, char** value, int* valueSize) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

iface key

- The external interface

- Pointer to the key - The size of the key in bytes

keySize value

- Pointer to the value (output) - The size of the key in bytes (output)

valueSize

Returns:
int

- 0 if the mapping resolved, non-zero if it did not

EXTERNAL_DeleteMapping

int EXTERNAL_DeleteMapping (EXTERNAL_Interface* iface, char* key, int keySize) Parameters:

Deletes a mapping created by EXTERNAL_CreateMapping.

iface key

- The external interface

- Pointer to the key - The size of the key in bytes

keySize

Returns:
int

- 0 if the mapping resolved, non-zero if it did not

EXTERNAL_ActivateNode

void EXTERNAL_ActivateNode (EXTERNAL_Interface* iface, Node* node) Parameters:

Activate a node so that it can begin processing events.

iface node

- The external interface

- The node

Returns:
void

- None

EXTERNAL_DectivateNode

void EXTERNAL_DectivateNode (EXTERNAL_Interface* iface, Node* node) Parameters:

Dectivate a node so that it stops processing events.

iface node

- The external interface

- The node

Returns:
void

- None

EXTERNAL_PHY_SetTxPower

void EXTERNAL_PHY_SetTxPower (Node* node, int phyIndex, double newTxPower)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

Parameters: Just like PHY_SetTxPower (), but able to handle setting transmission power when node is owned by a remote partition. Change to TxPower will be scheduled as "best-effort" for remote nodes. The range of coordinate values depends on the terrain data.
node

- The node (can be either a local node or remote) - The physical index - The new transmission power.

phyIndex

newTxPower

Returns:
void

- None

EXTERNAL_PHY_GetTxPower

void EXTERNAL_PHY_GetTxPower (Node* node, int phyIndex, double * txPowerPtr) Parameters:

Just like PHY_GetTxPower (), but able to handle getting transmission power when node is owned by a remote partition.

node

- The node (can be either a local node or remote) - The physical index - (OUT) value of transmission power will be

phyIndex

txPowerPtr

Returns:
void

- None

EXTERNAL_ChangeNodePosition

void EXTERNAL_ChangeNodePosition (EXTERNAL_Interface* iface, Node* node, double c1, double c2, double c3) Parameters:

iface node c1 c2 c3

- The external interface

- The node

- The first coordinate - The second coordinate - The third coordinate

Returns:
void

- None

EXTERNAL_ChangeNodeOrientation

void EXTERNAL_ChangeNodeOrientation (EXTERNAL_Interface* iface, Node* node, short azimuth, short elevation) Parameters:

Change the orientation of a node. Position is not changed. Azimuth/elevation are checked to be in the proper range, and are converted if they are not.

iface node

- The external interface

- The node - The azimuth, 0 <= azimuth <= 359

azimuth
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

elevation

- The elevation, -180 <= elevation <= 180

Returns:
void

- None

EXTERNAL_ChangeNodePositionAndOrientation

void EXTERNAL_ChangeNodePositionAndOrientation (EXTERNAL_Interface* iface, Node* node, double c1, double c2, double c3, short azimuth, short elevation) Parameters:

iface node c1 c2 c3

- The external interface

azimuth
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

elevation c1Speed c2Speed c3Speed

- The elevation, -180 <= elevation <= 180

- The rate of change of the first coordinate in the - The rate of change of the second coordinate in the - The rate of change of the third coordinate in the

Returns:
void

- None

EXTERNAL_ChangeNodeVelocityAtTime

void EXTERNAL_ChangeNodeVelocityAtTime (EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double speed, double c1Speed, double c2Speed, double c3Speed) Parameters:

iface node

- The external interface

- The node - The absolute simulation time (not delay)

mobilityEventTime speed

- The speed in m/s - The rate of change of the first coordinate in the - The rate of change of the second coordinate in the - The rate of change of the third coordinate in the

c1Speed c2Speed c3Speed

Returns:
void

- None

EXTERNAL_ChangeNodeVelocityAtTime

void EXTERNAL_ChangeNodeVelocityAtTime (EXTERNAL_Interface* iface, Node* node, clocktype mobilityEventTime, double c1Speed, double c2Speed, double c3Speed) Parameters:

Update the velocity vector of a node at a user-specified time. The velocity vector is expected to be in the same distance units used for the terrain, per one second.

iface node

- The external interface

- The node - The absolute simulation time (not delay)

mobilityEventTime c1Speed c2Speed c3Speed

- The rate of change of the first coordinate in the - The rate of change of the second coordinate in the - The rate of change of the third coordinate in the

Returns:
void
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

- None EXTERNAL_ConfigStringPresent BOOL EXTERNAL_ConfigStringPresent (NodeInput* nodeInput, char* string) Parameters: This function will check the config file for a string. Typically this is used during interface registration to see if the interface is turned on in the config file.
nodeInput string

- The configuration file

- The string to check for

Returns:
BOOL

- TRUE if the string is present, FALSE otherwise

EXTERNAL_ConfigStringIsYes

BOOL EXTERNAL_ConfigStringIsYes (NodeInput* nodeInput, char* string) Parameters:

This function will check the config file for a string. Typically this is used during interface registration to see if the interface is turned on in the config file. Checks that the string is YES.

nodeInput string

- The configuration file

- The string to check for

Returns:
BOOL

- TRUE if the string is YES, FALSE otherwise

EXTERNAL_MESSAGE_RemoteSend

void EXTERNAL_MESSAGE_RemoteSend (EXTERNAL_Interface* iface, int destinationPartitionId, Message * msg, clocktype delay, ExternalScheduleType scheduling) Parameters:

Send a message to the external interface on a different partition. This function makes it possible for your external interface to send a message to your external interface that is on on a different/remote partition. You will then need to add your message handler into the function EXTERNAL_ProcessEvent (). Lastly, you can request a besteffort delivery of your message to the remote external interface by passing in a delay value of 0 and a scheduling type of EXTERNAL_SCHEDULE_LOOSELY. Be aware that best-effort messages may be scheduled at slightly different simulation times each time your run your simulation. Further notes about scheduling. If your external event won't result in additional qualnet events, except those that will be scheduled after safe time, then you can use LOOSELY. If, your event is going to schedule additional qualnet event though, then you must use EXTERNAL_SCHEDULE_SAFE (so that the event is delayed to the next safe time). If you violate safe time you will get assertion failures for safe time of signal receive time. EXTERNAL_SetSimulationEndTime

iface

- Your external interface - The partitionId that you want to send to

destinationPartitionId msg

- The external message to send - When the message should be scheduled on the remote partion. - Whether this event can be executed lossely

delay

scheduling

Returns:
void

- None

void EXTERNAL_SetSimulationEndTime (partitionData* partitionData, clocktype endTime) Parameters:

partitionData endTime

- pointer to data for this partition

- The simulation time to end at.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

Returns:
void

- None

EXTERNAL_QueryRealTime

clocktype EXTERNAL_QueryRealTime () Parameters:

Returns:
clocktype

- The real time, not adjusted for simulation pauses.

clocktype EXTERNAL_QueryRealTime () Parameters:

Returns:
clocktype

- The real time, adjusted for simulation pauses.

clocktype EXTERNAL_QueryCPUTime (EXTERNAL_Interface* iface) Parameters:

This function will return the amount of Cpu time used by QualNet. The first call to this function will by an interface will return 0, and timing will begin from that point.

iface

- The external interface

Returns:
clocktype

- The CPU time

EXTERNAL_Sleep

void EXTERNAL_Sleep (clocktype amount) Parameters:

This function will sleep for a minimum amount of time as indicated by the amount parameter. Depending on which platform it is called on the amount of time spent sleeping could be greater.

amount

- The amount of time to sleep

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

EXTERNAL_UTILITIES

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/EXTERNAL_UTILITIES.html[5/24/2011 12:34:05 PM]

FILEIO

EXata 2.2 API Specification

FILEIO
This file describes data strucutres and functions used for reading from input files and printing to output files. Constant / Data Structure Summary Type
CONSTANT

Name
ANY_NODEID

Optional macro values to use when calling IO_Read...() APIs. Defines any node id.
CONSTANT ANY_ADDRESS

Optional macro values to use when calling IO_Read...() APIs. Defines any node address.
CONSTANT ANY_INSTANCE

Optional macro values to use when calling IO_Read...() APIs. Defines any instance.
CONSTANT MAX_INPUT_FILE_LINE_LENGTH

Maximum input file line length. Evaluates (6 * MAX_STRING_LENGTH)

CONSTANT MAX_ADDRESS_STRING_LENGTH

Maximum length of address string.

CONSTANT MAX_NUM_CACHED_FILES

Max number of -FILE references in an input file. (Restriction is only for immediate children)
CONSTANT MATCH_NODE_ID

Defines the matching by node id.

CONSTANT MATCH_NETWORK

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Defines the matching by network.

CONSTANT MATCH_INTERFACE

Defines the matching by interface.

CONSTANT INPUT_ALLOCATION_UNIT

Defines input allocation unit.

STRUCT NodeInput

Definition of node input structure. typedef to NodeInput in include/main.h.

Function / Macro Summary Return Type

void

Summary
IO_ConvertIpAddressToString(NodeAddress ipAddress, char* addressString)

Parses IPv4 address into a dotted-decimal string.

int IO_FindStringPos(const char s[], const char subString[])

Returns the index of the first subString found in s.

char* IO_GetToken(char* dst, const char* src, char ** next)

Searches source buffer for the first %s-style token encountered, and copies it to dst.
char* IO_GetDelimitedToken(char* dst, const char* src, const char* delim, char** next)

Searches source buffer for the first delimited token encountered, and copies it to dst.
const char* IO_Right(const char * s, unsigned count)

Returns a pointer to the right side of the string of length "count" characters.
char* IO_Chop(const char* s)

Removes the last character of string.

void IO_TrimNsbpSpaces(char* s)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Changes nsbp charecters for UTF-8 encoding to spaces.

void IO_TrimLeft(char* s)

Strips leading white space from a string (by memmove()ing string contents left).
void IO_TrimRight(char* s)

Strips trailing white space from a string (by inserting early NULL).
void IO_CompressWhiteSpace(char* s)

Compresses white space between words in the string to one space in a string. White space at the very beginning and very end of the string is also compressed to one space -- not stripped entirely.
BOOL IO_IsStringNonNegativeInteger(const char* s)

Returns TRUE if every character in string is a digit. (Even white space will cause return of FALSE)
void IO_ConvertStringToLowerCase(char s[])

Runs tolower() on each character in string and converts the same to lowercase.
void IO_ConvertStringToUpperCase(char s[])

Runs toupper() on each character in string and converts the same to uppercase.
BOOL IO_CaseInsensitiveStringsAreEqual(const char[] s1, const char[] s2, char lengthToCompare)

Checks two strings are equal or not ignoring case.

BOOL IO_BlankLine(char s[])

Checks the blank line/string.

BOOL IO_CommentLine(char s[])

Checks whether the line is a comment(i.e. starts with '#').

int IO_FindCaseInsensitiveStringPos(const char s[], const char subString[])

Finds the case insensitive sub string position in a string.

int IO_FindCaseInsensitiveStringPos(const char s[], const char subString[])

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Finds the case insensitive sub string position in a string.

IO_SkipToken.(char* token, char* tokenSep, char* skip)

skip the first n tokens.

NodeInput * IO_CreateNodeInput(NodeInput* nodeInput, const char* filename)

Allocates a NodeInput datastructure that can then be passed to IO_ReadNodeInput Called for each file variable in the config file.
void IO_InitializeNodeInput(NodeInput* nodeInput)

Initializes a NodeInput structure

void IO_ReadNodeInput(NodeInput* nodeInput, const char* filename)

Reads an input file into a NodeInput struct. Calls IO_ReadFileParameters to first read in -FILE paramters. Then calls IO_ReadFileParameters to read the rest of the parameters.
void IO_ReadNodeInputEx(NodeInput* nodeInput, const char* filename, const char* includeComment)

Reads an input file into a NodeInput struct. The includeComment Flag facilitate whether to include the commented line lines in the nodeInput structure or not. The commented lines should only be included in Backward Compatibity for Old scenario exe. This exe is responsible for creating new config file and router model file. These new files contains changes according to current VERSION of QualNet. Calls IO_ReadFileParameters to first read in -FILE paramters. Then calls IO_ReadFileParameters to read the rest of the parameters.
BOOL IO_ConvertFile(NodeInput* nodeInput, NodeInput* nodeOutput, char* version)

Converts the contents of an old configuration file to the latest version.

void IO_ReadLine(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal)

This API is used to retrieve a whole line from input files.

void IO_ReadString(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal)

This API is used to retrieve a string parameter value from input files.
void IO_ReadBool(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, BOOL* readVal)

This API is used to retrieve a boolean parameter value from input files.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

IO_ReadInt(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal)

This API is used to retrieve an integer parameter value from input files.
void IO_ReadDouble(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, double* readVal)

This API is used to retrieve a double parameter value from input files.
void IO_ReadFloat(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, float* readVal)

This API is used to retrieve a float parameter value from input files.
void IO_ReadTime(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, clocktype* readVal)

This API is used to retrieve time parameter value from input files.
void IO_ReadCachedFile(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve cached file parameter value from input files.
void IO_ReadStringInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue)

This API is used to retrieve string parameter values from input files for a specific instance.
void IO_ReadBoolInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, BOOL* parameterValue)

This API is used to retrieve boolean parameter values from input files for a specific instance.
void IO_ReadIntInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue)

This API is used to retrieve integer parameter values from input files for a specific instance.
void IO_ReadDoubleInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue)

This API is used to retrieve double parameter values from input files for a specific instance.
void IO_ReadFloatInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch,

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

BOOL* wasFound, float* parameterValue)

This API is used to retrieve float parameter values from input files for a specific instance.
void IO_ReadTimeInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue)

This API is used to retrieve time parameter values from input files for a specific instance.
void IO_ReadCachedFileInstance(const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve file parameter values from input files for a specific instance.
void IO_ParseNodeIdHostOrNetworkAddress(const char s[], NodeAddress* outputNodeAddress, int* numHostBits, BOOL* isNodeId)

Parses a string for a nodeId, host address, or network address.

void IO_ParseNodeIdOrHostAddress(const char s[], NodeAddress* outputNodeAddress, BOOL* isNodeId)

Parses a string for a nodeId or host address.

void IO_ParseNetworkAddress(const char s[], NodeAddress* outputNodeAddress, int* numHostBits)

Parses a string for a network address.

void IO_FreeNodeInput(NodeInput* nodeInput)

Frees a NodeInput struct. (Currently unused.)

void IO_PrintStat(Node* node, const char* layer, const char* protocol, NodeAddress interfaceAddress, int instanceId, const char* buf)

Print out the relevant stat in "buf", along with the node id and the layer type generating this stat.
void IO_AppParseSourceAndDestStrings(Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, NodeAddress* sourceAddr, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr)

Application input parsing API. Parses the source and destination strings.
void IO_AppParseSourceString(Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, NodeAddress* sourceAddr)

Application input parsing API. Parses the source string.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

IO_AppParseDestString(Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr)

Application input parsing API. Parses the destination string.

void IO_AppParseHostString(Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr)

Application input parsing API. Parses the host string.

void IO_AppForbidSameSourceAndDest(const char* inputString, NodeAddress sourceNodeId, NodeAddress destNodeId)

Application input checking API. Checks for the same source and destination node id. Calls abort() for same source and destination.
BOOL QualifierMatches(const NodeAddress nodeId, const NodeAddress interfaceAddress, const char* qualifier, int* matchType)

This is an auxiliary API used by the IO_Read...() set of APIs.

void IO_ReadBool(const NodeAddress nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, BOOL* parameterValue)

This API is used to retrieve boolean parameter values from input files. Overloaded API for Ipv6 compatibility.
None IO_ReadBool()

Reads boolean value for specified ATM address.

void IO_ReadBool(const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, BOOL* parameterValue)

This API is used to retrieve boolean parameter values from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadString(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal)

This API is used to retrieve a string parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadString(const NodeId nodeId, const AtmAddress* interfaceAddress, const NodeInput * nodeInput, const char * parameterName, BOOL * wasFound, char * parameterValue)

Reads string value for specified ATM address.

void IO_ReadString(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal)

This API is used to retrieve a string parameter value from input files. Overloaded API for Ipv6 compatibility.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

IO_ReadInt(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal)

This API is used to retrieve an integer parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadInt(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal)

This API is used to retrieve an integer parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadInt()

Reads int value for specified ATM address.

void IO_ReadDouble(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, double* readVal)

This API is used to retrieve a double parameter value from input files. Overloaded API for Ipv6 compatibility.
None IO_ReadDouble()

Reads double value for specified ATM address.

void IO_ReadDouble(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, double* readVal)

This API is used to retrieve a double parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadFloat(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, float* readVal)

This API is used to retrieve a float parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadFloat()

Reads float value for specified ATM address.

void IO_ReadFloat(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, float* readVal)

This API is used to retrieve a float parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadTime(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, clocktype* readVal)

This API is used to retrieve time parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadTime()
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Reads time value for specified ATM address.

void IO_ReadTime(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, clocktype* readVal)

This API is used to retrieve time parameter value from input files. Overloaded API for Ipv6 compatibility.
None IO_ReadBoolInstance()

Reads BOOL value for specified ATM address.

void IO_ReadStringInstance(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue)

This API is used to retrieve string parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadStringInstance()

Reads string value for specified ATM address.

void IO_ReadStringInstance(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue)

This API is used to retrieve string parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadIntInstance(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue)

This API is used to retrieve integer parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadIntInstance(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue)

This API is used to retrieve integer parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadDoubleInstance(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue)

This API is used to retrieve double parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadDoubleInstance()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Reads double value for specified ATM address.

void IO_ReadDoubleInstance(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue)

This API is used to retrieve double parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadFloatInstance(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, float* parameterValue)

This API is used to retrieve float parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadFloatInstance(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, float* parameterValue)

This API is used to retrieve float parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadTimeInstance(const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue)

This API is used to retrieve time parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadTimeInstance()

Reads clocktype value for specified ATM address.

void IO_ReadTimeInstance(const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue)

This API is used to retrieve time parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_ReadCachedFile(const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve cached file parameter value from input files. Overloaded API for Ipv6 compatibility.
void IO_ReadCachedFileInstance(const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve file parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.
void IO_PrintStat(Node* node, const char* layer, const char* protocol, const char* interfaceAddress, int instanceId, const char* buf)

Print out the relevant stat in "buf", along with the node id and the layer type generating this stat. Overloaded API for Ipv6 compatibility.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

IO_ParseNodeIdHostOrNetworkAddress(const char s[], in6_addr* ipAddress, BOOL* isIpAddr, NodeId* nodeId)

Parses a string for a nodeId, host address, or network address. Overloaded API for Ipv6 compatibility.
void IO_ParseNodeIdHostOrNetworkAddress(const char s[], ATM addr* atmAddress, BOOL* isAtmAddr, NodeId* nodeId)

Parses a string for a nodeId, host address, or network address. Overloaded API for Ipv6 compatibility.
void IO_ParseNodeIdOrHostAddress(const char s[], in6_addr* outputNodeAddress, BOOL* isNodeId)

Parses a string for a nodeId or host address.

void IO_ParseNetworkAddress(const char s[], unsigned int* tla, unsigned int* nla, unsigned int* sla)

Parses a string for a network address. Overloaded API for Ipv6 compatibility.
void IO_AppParseSourceAndDestStrings(Node* node, const char* inputString, const char* sourceString, NodeId* sourceNodeId, Address* sourceAddr, const char* destString, NodeId* destNodeId, Address* destAddr)

Application input parsing API. Parses the source and destination strings. Overloaded for Ipv6 compatibility.
void IO_AppParseSourceString(Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, Address* sourceAddr, NetworkType networkType)

Application input parsing API. Parses the source string. Overloaded for Ipv6 compatibility.
void IO_AppParseDestString(Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, Address* destAddr, NetworkType networkType)

Application input parsing API. Parses the destination string. Overloaded for Ipv6 compatibility.
BOOL QualifierMatches(const NodeId nodeId, const in6_addr interfaceAddress, const char* qualifier, int* matchType)

This is an auxiliary API used by the IO_Read...() set of APIs. Overloaded for Ipv6 compatibility
BOOL QualifierMatches(const NodeId nodeId, const AtmAddress* interfaceAddress, const char* qualifier, int* matchType)

This is an auxiliary API used by the IO_Read...() set of APIs. Overloaded for Ipv6 compatibility
void IO_ConvertIpv6StringToAddress()(char* interfaceAddr, in6_addr* ipAddress)

Convert IPv6 address string to in6_addr structure. API for Ipv6 compatibility.
void IO_ConvertIpAddressToString(in6_addr* ipAddress, char* interfaceAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Parses IPv6 address into a formatted string. Overloaded API for Ipv6 compatibility.
void IO_ConvertIpAddressToString(Address* ipAddress, char* interfaceAddr)

Parses IPv6 address into a formatted string. Overloaded API for Ipv6 compatibility.
void IO_ConvertStringToNodeAddress(char* addressString, NodeAddress* outputNodeAddress)

This API is used to covert a string parameter to NodeAdress.

BOOL IO_CheckIsSameAddress(Address addr1, Address addr2)

Compares IPv4 | IPv6 address. API for Ipv6 compatibility.

void IO_ReadString(Node* node node, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal)

This API is used to retrieve a string parameter value from input files.
void IO_CacheFile(const NodeInput* nodeInput, const char* filename)

This API is used to read an auxiliary input file into a NodeInput struct Called for each file variable in the config file.
int IO_GetMaxLen(fileName char*)

This API is used to get the maximun length of a line in the file.
int IO_GetMaxLen(fp FILE*)

This API is used to get the maximun length of a line in the file.
int NI_GetMaxLen(nodeInput NodeInput*)

This API is used to get the maximun length of a line in nodeInput.

int NI_GetMaxLen(nodeInput const NodeInput*)

This API is used to get the maximun length of a line in nodeInput.

void IO_ParseNetworkAddress(const char s[], unsigned int* u_atmVal)

Parses a string for a network address. Overloaded API for ATM compatibility.
void IO_ConvertAddrToString(Address* address, char* addrStr)

Convert generic address to appropriate network type address string format.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

IO_ConvertAtmAddressToString(AtmAddress addr, char* addrStr)

Convert Atm address to address string format.

void IO_InsertIntValue(const char s[], const unsigned int val, unsigned int u_atmVal)

Insert integer value for specific string in case of ATM

int IO_ReadCachedFileIndex(NodeAddress nodeId, NodeAddress interfaceAddress, unsigned int nodeInput)

Return Cached file index for the given parameter name

void IO_ReadString(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue)

This API is used to retrieve a string parameter value from input files.
void IO_ReadInt64(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, Int64* parameterValue)

This API is used to retrieve a Int64 parameter value from input files.
void IO_ReadTime(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, clocktype* parameterValue)

This API is used to retrieve a clocktype parameter value from input files.
void IO_ReadInt(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, int* parameterValue)

This API is used to retrieve a Int parameter value from input files.
void IO_ReadDouble(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, double* parameterValue)

This API is used to retrieve a double parameter value from input files.
void IO_ReadCachedFile(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve a cached file parameter value from input files.
void IO_ReadLine(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue)

This API is used to retrieve a whole line from input files.

void IO_ReadStringInstance(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue)

This API is used to retrieve string parameter values from input files for a specific instance.
void IO_ReadDoubleInstance(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue)

This API is used to retrieve double parameter values from input files for a specific instance.
void IO_ReadIntInstance(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue)

This API is used to retrieve int parameter values from input files for a specific instance.
void IO_ReadTimeInstance(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue)

This API is used to retrieve clocktype parameter values from input files for a specific instance.
void IO_ReadCachedFileInstance(Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue)

This API is used to retrieve cached file parameter values from input files for a specific instance.
void IO_ReadStringUsingIpAddress(Node* node, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue)

This API is used to retrieve a string parameter value from input files using the ip-address.
void IO_ReadString(const NodeAddress nodeId, NodeAddress ipv4Address, in6_addr* ipv6Address, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue)

This API is used to retrieve a string parameter value from input files.
void IO_ReadString(const NodeAddress nodeId, int interfaceIndex, const NodeAddress ipv4SubnetAddress, const in6_addr* ipv6SubnetAddress, const NodeInput* nodeInput, const char* parameterName, char* parameterValue, BOOL& wasFound, int& matchType)

This API is used to retrieve a string parameter value from input files.

Constant / Data Structure Detail

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Constant

ANY_NODEID 0xffffffff

Constant

Optional macro values to use when calling IO_Read...() APIs. Defines any node id. ANY_ADDRESS 0xffffffff

Constant

Optional macro values to use when calling IO_Read...() APIs. Defines any node address. ANY_INSTANCE 0xffffffff

Constant

Optional macro values to use when calling IO_Read...() APIs. Defines any instance. MAX_INPUT_FILE_LINE_LENGTH 6 * MAX_STRING_LENGTH

Structure

Defines input allocation unit. NodeInput

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Definition of node input structure. typedef to NodeInput in include/main.h.

Function / Macro Detail Function / Macro IO_ConvertIpAddressToString Format void IO_ConvertIpAddressToString (NodeAddress ipAddress, char* addressString) Parameters: Parses IPv4 address into a dotted-decimal string.
ipAddress

- IPv4 address to be converted into - Storage for string.

addressString

Returns:
void

- None

IO_FindStringPos

int IO_FindStringPos (const char s[], const char subString[]) Parameters:

Returns the index of the first subString found in s.

s[]

- Source string. - Substring to earch for.

subString[]

Returns:
int

- Index of the first subString found in s. -1, if not found.

IO_GetToken

char* IO_GetToken (char* dst, const char* src, char ** next) Parameters:

Searches source buffer for the first %s-style token encountered, and copies it to dst.

dst src

- Buffer to copy token too. If passed in as - Source string. - Storage for pointer to remainder of string.

Returns:
char*

- dst, if string was found and dst was passed in as non-NULL. Pointer to token in src, if string was found and dst was passed in as NULL. NULL, otherwise.

IO_GetDelimitedToken

char* IO_GetDelimitedToken (char* dst, const char* src, const char* delim, char** next) Parameters:

Searches source buffer for the first delimited token encountered, and copies it to dst.

dst

- Buffer to copy token too. If passed in as

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

src

- Source string. - Delimiter string.

delim next

- Storage for pointer to remainder of string.

Returns:
char*

- dst, if string was found and dst was passed in as non-NULL. Pointer to token in src, if string was found and dst was passed in as NULL. NULL, otherwise.

IO_Right

const char* IO_Right (const char * s, unsigned count) Parameters:

Returns a pointer to the right side of the string of length "count" characters.

- String. - Number of characters on the right side.

count

Returns:
const char*

- A pointer to the right side of the string of length "count" characters. If count is 0, then a pointer to the string's terminating NULL is returned. If count is equal to or greater than the number of characters in the string, then the whole string is returned. A "character" is just a byte of char type that's not NULL. So, '\n' counts as a character.

IO_Chop

char* IO_Chop (const char* s) Parameters:

Removes the last character of string.

- String.

Returns:
char*

- s. If the string has a strlen() of zero, then the string is returned unmodified. A "character" is just a byte of char type that's not NULL. So, '\n' counts as a character.

IO_TrimNsbpSpaces

void IO_TrimNsbpSpaces (char* s) Parameters:

Changes nsbp charecters for UTF-8 encoding to spaces.

- String.

Returns:
void

- None

IO_TrimLeft

void IO_TrimLeft (char* s) Parameters:

Strips leading white space from a string (by memmove()ing string contents left).

- String.

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

IO_TrimRight

void IO_TrimRight (char* s) Parameters:

Strips trailing white space from a string (by inserting early NULL).

- String.

Returns:
void

- None

IO_CompressWhiteSpace

void IO_CompressWhiteSpace (char* s) Parameters:

Compresses white space between words in the string to one space in a string. White space at the very beginning and very end of the string is also compressed to one space -not stripped entirely. IO_IsStringNonNegativeInteger

- String.

Returns:
void

- None

BOOL IO_IsStringNonNegativeInteger (const char* s) Parameters:

Returns TRUE if every character in string is a digit. (Even white space will cause return of FALSE)

- String.

Returns:
BOOL

- TRUE if every character is a digit. FALSE, otherwise.

IO_ConvertStringToLowerCase

void IO_ConvertStringToLowerCase (char s[]) Parameters:

Runs tolower() on each character in string and converts the same to lowercase.

s[]

- String.

Returns:
void

- None

IO_ConvertStringToUpperCase

void IO_ConvertStringToUpperCase (char s[]) Parameters:

Runs toupper() on each character in string and converts the same to uppercase.

s[]

- String.

Returns:
void

- None

IO_CaseInsensitiveStringsAreEqual

BOOL IO_CaseInsensitiveStringsAreEqual (const char[] s1, const char[] s2, char lengthToCompare) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Checks two strings are equal or not ignoring case.

s1 s2

- First string. - Second string. - Length to compare.

lengthToCompare

Returns:
BOOL

- Returns TRUE if strings are equal, FALSE otherwise.

IO_BlankLine

BOOL IO_BlankLine (char s[]) Parameters:

Checks the blank line/string.

s[]

- String.

Returns:
BOOL

- Returns TRUE if the string is blank. FALSE, otherwise.

IO_CommentLine

BOOL IO_CommentLine (char s[]) Parameters:

Checks whether the line is a comment(i.e. starts with '#').

s[]

- String.

Returns:
BOOL

- Returns TRUE if the line is a comment. FALSE, otherwise.

IO_FindCaseInsensitiveStringPos

int IO_FindCaseInsensitiveStringPos (const char s[], const char subString[]) Parameters:

Finds the case insensitive sub string position in a string.

s[]

- String. - Sub string

subString[]

Returns:
int

- Returns the position of case insensitive sub string if found. -1, otherwise.

IO_FindCaseInsensitiveStringPos

int IO_FindCaseInsensitiveStringPos (const char s[], const char subString[]) Parameters:

Finds the case insensitive sub string position in a string.

s[]

- String. - Sub string

subString[]

Returns:
int

- Returns the position of case insensitive sub string if found. -1, otherwise.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

IO_SkipToken.

IO_SkipToken. (char* token, char* tokenSep, char* skip) Parameters:

skip the first n tokens.

token

- pointer to the input string, - pointer to the token separators,

tokenSep skip

- number of skips.

Returns: IO_CreateNodeInput NodeInput * IO_CreateNodeInput (NodeInput* nodeInput, const char* filename) Parameters: Allocates a NodeInput datastructure that can then be passed to IO_ReadNodeInput Called for each file variable in the config file.
nodeInput filename

- Pointer to node input.

- Path to input file.

Returns:
NodeInput *

- None

IO_InitializeNodeInput

void IO_InitializeNodeInput (NodeInput* nodeInput) Parameters:

Initializes a NodeInput structure

nodeInput

- A pointer to NodeInput structure.

Returns:
void

- None

IO_ReadNodeInput

void IO_ReadNodeInput (NodeInput* nodeInput, const char* filename) Parameters:

Reads an input file into a NodeInput struct. Calls IO_ReadFileParameters to first read in FILE paramters. Then calls IO_ReadFileParameters to read the rest of the parameters.

nodeInput filename

- Pointer to node input.

- Path to input file.

Returns:
void

- None

IO_ReadNodeInputEx

void IO_ReadNodeInputEx (NodeInput* nodeInput, const char* filename, const char* includeComment) Parameters:

Reads an input file into a NodeInput struct. The includeComment Flag facilitate whether to include the commented line lines in the

nodeInput filename

- Pointer to node input.

- Path to input file.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

nodeInput structure or not. The commented lines should only be included in Backward Compatibity for Old scenario exe. This exe is responsible for creating new config file and router model file. These new files contains changes according to current VERSION of QualNet. Calls IO_ReadFileParameters to first read in -FILE paramters. Then calls IO_ReadFileParameters to read the rest of the parameters. IO_ConvertFile

includeComment

- When this flag is true it

Returns:
void

- None

BOOL IO_ConvertFile (NodeInput* nodeInput, NodeInput* nodeOutput, char* version) Parameters:

Converts the contents of an old configuration file to the latest version.

nodeInput

- A pointer to node input. - A pointer to node input. Goes through

nodeOutput version

- Not used.

Returns:
BOOL

- Returns TRUE if able to convert. FALSE, otherwise. Either couldn't load the database or something else bad happened, so just copy the old into the new.

IO_ReadLine

void IO_ReadLine (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal) Parameters:

This API is used to retrieve a whole line from input files.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal) Parameters:

This API is used to retrieve a string parameter value from input files.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadBool

void IO_ReadBool (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, BOOL* readVal) Parameters:

This API is used to retrieve a boolean parameter value from input files.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadInt

void IO_ReadInt (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal) Parameters:

This API is used to retrieve an integer parameter value from input files.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

FILEIO

readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadCachedFile

void IO_ReadCachedFile (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, NodeInput* parameterValue) Parameters:

This API is used to retrieve cached file parameter value from input files.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach. - Storage for parameter value.

wasFound

parameterValue

Returns:
void

- None

IO_ReadStringInstance

void IO_ReadStringInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue) Parameters:
nodeId

This API is used to retrieve string parameter values from input files for a specific instance.

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadBoolInstance

void IO_ReadBoolInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput,

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, BOOL* parameterValue) This API is used to retrieve boolean parameter values from input files for a specific instance. Parameters:
nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadIntInstance

void IO_ReadIntInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue) Parameters:
nodeId

This API is used to retrieve integer parameter values from input files for a specific instance.

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadDoubleInstance

void IO_ReadDoubleInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

This API is used to retrieve double parameter values from input files for a specific instance.

Parameters:
nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadFloatInstance

void IO_ReadFloatInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, float* parameterValue) Parameters:
nodeId

This API is used to retrieve float parameter values from input files for a specific instance.

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadTimeInstance

void IO_ReadTimeInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue) Parameters:
nodeId

This API is used to retrieve time parameter values from input files for a specific instance.

- nodeId. Can be ANY_NODEID.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

interfaceAddress nodeInput

- IP address of interface.

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadCachedFileInstance

void IO_ReadCachedFileInstance (const NodeAddress nodeId, const NodeAddress interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue) Parameters:
nodeId

This API is used to retrieve file parameter values from input files for a specific instance.

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ParseNodeIdHostOrNetworkAddress

void IO_ParseNodeIdHostOrNetworkAddress (const char s[], NodeAddress* outputNodeAddress, int* numHostBits, BOOL* isNodeId) Parameters:

Parses a string for a nodeId, host address, or network address.

s[]

- String to parse. - Storage for nodeId or IP address.

outputNodeAddress numHostBits

- Storage for number of host bits

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Returns:
void

- None

IO_PrintStat

void IO_PrintStat (Node* node, const char* layer, const char* protocol, NodeAddress interfaceAddress, int instanceId, const char* buf) Parameters:

Print out the relevant stat in "buf", along with the node id and the layer type generating this stat.

node

- The node generating the stat. - The layer generating the stat. - The protocol generating the stat.

layer

protocol

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

interfaceAddress instanceId buf

- Interface address.

- Instance id.

- String which has the statistic to

Returns:
void

- None

IO_AppParseSourceAndDestStrings

void IO_AppParseSourceAndDestStrings (Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, NodeAddress* sourceAddr, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr) Parameters:
node

Application input parsing API. Parses the source and destination strings.

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr destString destNodeId destAddr

- A pointer to NodeAddress. - Const char pointer. - A pointer to NodeAddress.

- A pointer to NodeAddress.

Returns:
void

- None

IO_AppParseSourceString

void IO_AppParseSourceString (Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, NodeAddress* sourceAddr) Parameters:

Application input parsing API. Parses the source string.

node

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr

- A pointer to NodeAddress.

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

IO_AppParseDestString

void IO_AppParseDestString (Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr) Parameters:

Application input parsing API. Parses the destination string.

node

- A pointer to Node. - The input string.

inputString destString destNodeId destAddr

- Const char pointer. - A pointer to NodeAddress.

- A pointer to NodeAddress.

Returns:
void

- None

IO_AppParseHostString

void IO_AppParseHostString (Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, NodeAddress* destAddr) Parameters:

Application input parsing API. Parses the host string.

node

- A pointer to Node. - The input string.

inputString destString destNodeId destAddr

- Const char pointer. - A pointer to NodeAddress.

- A pointer to NodeAddress.

Returns:
void

- None

IO_AppForbidSameSourceAndDest

void IO_AppForbidSameSourceAndDest (const char* inputString, NodeAddress sourceNodeId, NodeAddress destNodeId) Parameters:

Application input checking API. Checks for the same source and destination node id. Calls abort() for same source and destination.

inputString

- The input string. - Source node id, read from the

sourceNodeId destNodeId

- Destination node id, read from the

Returns:
void

- None

QualifierMatches

BOOL QualifierMatches (const NodeAddress nodeId, const NodeAddress interfaceAddress, const char* qualifier, int* matchType)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Parameters: This is an auxiliary API used by the IO_Read...() set of APIs.

nodeId

- nodeId to select for. - IP address to select for.

interfaceAddress qualifier matchType

- String containing the - Stores the type of the match,

Returns:
BOOL

- Returns TRUE if match found. FALSE, otherwise.

IO_ReadBool

void IO_ReadBool (const NodeAddress nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, BOOL* parameterValue) Parameters:

This API is used to retrieve boolean parameter values from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadBool

None IO_ReadBool () Parameters:

Reads boolean value for specified ATM address. IO_ReadBool

Returns:
None

- None

void IO_ReadBool (const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, BOOL* parameterValue) Parameters:

This API is used to retrieve boolean parameter values from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input. - Parameter name.

address

nodeInput

parameterName

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal) Parameters:

This API is used to retrieve a string parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeId nodeId, const AtmAddress* interfaceAddress, const NodeInput * nodeInput, const char * parameterName, BOOL * wasFound, char * parameterValue) Parameters:

Reads string value for specified ATM address.

nodeId

- NodeId for which parameter has - ATM Interface address

interfaceAddress nodeInput

- pointer to configuration inputs - Parameter to be read

parameterName wasFound

- Parameter found or not - Parameter's value if found.

parameterValue

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

This API is used to retrieve a string parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IP address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadInt

void IO_ReadInt (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal) Parameters:

This API is used to retrieve an integer parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadInt

void IO_ReadInt (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, int* readVal) Parameters:

This API is used to retrieve an integer parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Returns:
void

- None

IO_ReadInt

void IO_ReadInt () Parameters:

Reads int value for specified ATM address.

Returns:
void

- None NOTE: Overloaded API IO_ReadInt()

IO_ReadDouble

void IO_ReadDouble (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, double* readVal) Parameters:

This API is used to retrieve a double parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadDouble

None IO_ReadDouble () Parameters:

Reads double value for specified ATM address. IO_ReadDouble

Returns:
None

- None

void IO_ReadDouble (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, double* readVal) Parameters:

This API is used to retrieve a double parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach.

wasFound

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadFloat

void IO_ReadFloat (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, float* readVal) Parameters:

This API is used to retrieve a float parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadFloat

void IO_ReadFloat () Parameters:

Reads float value for specified ATM address.

Returns:
void

- None NOTE: Overloaded API IO_ReadFloat()

IO_ReadFloat

void IO_ReadFloat (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, float* readVal) Parameters:

This API is used to retrieve a float parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

- None

IO_ReadTime

void IO_ReadTime (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* index, BOOL* wasFound, clocktype* readVal) Parameters:

This API is used to retrieve time parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput index

- Pointer to node input.

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadTime

void IO_ReadTime () Parameters:

Reads time value for specified ATM address.

Returns:
void

- None

IO_ReadTime

void IO_ReadTime (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, clocktype* readVal) Parameters:

This API is used to retrieve time parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_ReadBoolInstance

None IO_ReadBoolInstance () Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Reads BOOL value for specified ATM address. IO_ReadStringInstance

Returns:
None

- None

void IO_ReadStringInstance (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue) Parameters:
nodeId

This API is used to retrieve string parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadStringInstance

void IO_ReadStringInstance () Parameters:

Reads string value for specified ATM address. IO_ReadStringInstance

Returns:
void

- None NOTE: Overloaded API IO_ReadStringInstance()

void IO_ReadStringInstance (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue) Parameters:
nodeId

This API is used to retrieve string parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input. - Parameter name. - Instance number.

address

nodeInput

parameterName

parameterInstanceNumber

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

fallbackIfNoInstanceMatch wasFound

- Selects parameter without

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadIntInstance

void IO_ReadIntInstance (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue) Parameters:
nodeId

This API is used to retrieve integer parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadIntInstance

void IO_ReadIntInstance (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue) Parameters:
nodeId

This API is used to retrieve integer parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

address

nodeInput

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterValue

- Storage for parameter value.

Returns:
void

- None

IO_ReadDoubleInstance

void IO_ReadDoubleInstance (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue) Parameters:
nodeId

This API is used to retrieve double parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadDoubleInstance

void IO_ReadDoubleInstance () Parameters:

Reads double value for specified ATM address. IO_ReadDoubleInstance

Returns:
void

- None NOTE: Overloaded API IO_ReadDoubleInstance()

void IO_ReadDoubleInstance (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue) Parameters:
nodeId

This API is used to retrieve double parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface. - Pointer to node input. - Parameter name.

address

nodeInput

parameterName

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterInstanceNumber

- Instance number. - Selects parameter without

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadFloatInstance

void IO_ReadFloatInstance (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, float* parameterValue) Parameters:
nodeId

This API is used to retrieve float parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadFloatInstance

void IO_ReadFloatInstance (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, float* parameterValue) Parameters:
nodeId

This API is used to retrieve float parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

address

nodeInput

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadTimeInstance

void IO_ReadTimeInstance (const NodeId nodeId, const in6_addr* interfaceAddress, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue) Parameters:
nodeId

This API is used to retrieve time parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - IPv6 address of interface.

interfaceAddress nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadTimeInstance

void IO_ReadTimeInstance () Parameters:

Reads clocktype value for specified ATM address. IO_ReadTimeInstance

Returns:
void

- None NOTE: Overloaded API IO_ReadTimeInstance()

void IO_ReadTimeInstance (const NodeId nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue) Parameters:
nodeId

This API is used to retrieve time parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterName

- Parameter name. - Instance number. - Selects parameter without

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadCachedFile

void IO_ReadCachedFile (const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* index, BOOL* wasFound, NodeInput* parameterValue) Parameters:

This API is used to retrieve cached file parameter value from input files. Overloaded API for Ipv6 compatibility.

nodeId

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input.

address

nodeInput index

- Parameter name. - Storage for success of seach. - Storage for parameter value.

wasFound

parameterValue

Returns:
void

- None

IO_ReadCachedFileInstance

void IO_ReadCachedFileInstance (const NodeAddress nodeId, const Address* address, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue) Parameters:
nodeId

This API is used to retrieve file parameter values from input files for a specific instance. Overloaded API for Ipv6 compatibility.

- nodeId. Can be ANY_NODEID. - Address of interface. - Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

address

nodeInput

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterValue

- Storage for parameter value.

Returns:
void

- None

IO_PrintStat

void IO_PrintStat (Node* node, const char* layer, const char* protocol, const char* interfaceAddress, int instanceId, const char* buf) Parameters:

Print out the relevant stat in "buf", along with the node id and the layer type generating this stat. Overloaded API for Ipv6 compatibility.

node

- The node generating the stat. - The layer generating the stat. - The protocol generating the stat. - The Interface address the stat.

layer

protocol

interfaceAddress instanceId buf

- Instance id.

- String which has the statistic to

Returns:
void

- None

IO_ParseNodeIdHostOrNetworkAddress

void IO_ParseNodeIdHostOrNetworkAddress (const char s[], in6_addr* ipAddress, BOOL* isIpAddr, NodeId* nodeId) Parameters:

Parses a string for a nodeId, host address, or network address. Overloaded API for Ipv6 compatibility.

s[]

- String to parse. - Storage for ipv6address.

ipAddress isIpAddr nodeId

- Storage for whether the string is

- Storage for nodeId.

Returns:
void

- None

IO_ParseNodeIdHostOrNetworkAddress

void IO_ParseNodeIdHostOrNetworkAddress (const char s[], ATM addr* atmAddress, BOOL* isAtmAddr, NodeId* nodeId) Parameters:

Parses a string for a nodeId, host address, or network address. Overloaded API for Ipv6 compatibility.

s[]

- String to parse. - Storage for ATMaddress.

atmAddress isAtmAddr nodeId

- Storage for whether the string is

- Storage for nodeId.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Returns:
void

- None

IO_ParseNodeIdOrHostAddress

void IO_ParseNodeIdOrHostAddress (const char s[], in6_addr* outputNodeAddress, BOOL* isNodeId) Parameters:

Parses a string for a nodeId or host address.

s[]

- String to parse. - Storage for ipv6address.

outputNodeAddress isNodeId

- Storage for whether the string is

Returns:
void

- None

IO_ParseNetworkAddress

void IO_ParseNetworkAddress (const char s[], unsigned int* tla, unsigned int* nla, unsigned int* sla) Parameters:

Parses a string for a network address. Overloaded API for Ipv6 compatibility.

s[] tla nla sla

- String to parse. - Storage for tla - Storage for nla. - Storage for sla.

Returns:
void

- None

IO_AppParseSourceAndDestStrings

void IO_AppParseSourceAndDestStrings (Node* node, const char* inputString, const char* sourceString, NodeId* sourceNodeId, Address* sourceAddr, const char* destString, NodeId* destNodeId, Address* destAddr) Parameters:

Application input parsing API. Parses the source and destination strings. Overloaded for Ipv6 compatibility.

node

- A pointer to Node. - The input string. - The source string. - A pointer to NodeId.

inputString

sourceString sourceNodeId sourceAddr destString destNodeId destAddr

- A pointer to Address. - Const char pointer. - A pointer to NodeId.

- A pointer to Address.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Returns:
void

- None

IO_AppParseSourceString

void IO_AppParseSourceString (Node* node, const char* inputString, const char* sourceString, NodeAddress* sourceNodeId, Address* sourceAddr, NetworkType networkType) Parameters:

Application input parsing API. Parses the source string. Overloaded for Ipv6 compatibility.

node

- A pointer to Node. - The input string. - The source string. - A pointer to NodeAddress.

inputString

sourceString sourceNodeId sourceAddr

- A pointer to Address. - used when sourceString

networkType

Returns:
void

- None

IO_AppParseDestString

void IO_AppParseDestString (Node* node, const char* inputString, const char* destString, NodeAddress* destNodeId, Address* destAddr, NetworkType networkType) Parameters:

Application input parsing API. Parses the destination string. Overloaded for Ipv6 compatibility.

node

- A pointer to Node. - The input string.

inputString destString destNodeId destAddr

- Const char pointer. - A pointer to NodeAddress.

- A pointer to Address. - used when sourceString

networkType

Returns:
void

- None

QualifierMatches

BOOL QualifierMatches (const NodeId nodeId, const in6_addr interfaceAddress, const char* qualifier, int* matchType) Parameters:

This is an auxiliary API used by the IO_Read...() set of APIs. Overloaded for Ipv6 compatibility

nodeId

- nodeId to select for. - IPv6 address to select for.

interfaceAddress qualifier

- String containing the

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

matchType

- Stores the type of the match,

Returns:
BOOL

- Returns TRUE if match found. FALSE, otherwise.

QualifierMatches

BOOL QualifierMatches (const NodeId nodeId, const AtmAddress* interfaceAddress, const char* qualifier, int* matchType) Parameters:

This is an auxiliary API used by the IO_Read...() set of APIs. Overloaded for Ipv6 compatibility

nodeId

- nodeId to select for. - ATM address to select for.

interfaceAddress qualifier matchType

- String containing the - Stores the type of the match,

Returns:
BOOL

- Returns TRUE if match found. FALSE, otherwise.

IO_ConvertIpv6StringToAddress()

void IO_ConvertIpv6StringToAddress() (char* interfaceAddr, in6_addr* ipAddress) Parameters:

Convert IPv6 address string to in6_addr structure. API for Ipv6 compatibility.

interfaceAddr ipAddress

- Storage for ipv6address string

- Storage for ipv6address.

Returns:
void

- None

IO_ConvertIpAddressToString

void IO_ConvertIpAddressToString (in6_addr* ipAddress, char* interfaceAddr) Parameters:

Parses IPv6 address into a formatted string. Overloaded API for Ipv6 compatibility.

ipAddress

- Storage for ipv6address. - Storage for ipv6address string

interfaceAddr

Returns:
void

- None

IO_ConvertIpAddressToString

void IO_ConvertIpAddressToString (Address* ipAddress, char* interfaceAddr) Parameters:

Parses IPv6 address into a formatted string. Overloaded API for Ipv6 compatibility.

ipAddress

- IP address info - Storage for ipv6address string

interfaceAddr

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Returns:
void

- None

IO_ConvertStringToNodeAddress

void IO_ConvertStringToNodeAddress (char* addressString, NodeAddress* outputNodeAddress) Parameters:

This API is used to covert a string parameter to NodeAdress.

addressString

- IP address string info - Storage for IP address

outputNodeAddress

Returns:
void

- None

IO_CheckIsSameAddress

BOOL IO_CheckIsSameAddress (Address addr1, Address addr2) Parameters:

Compares IPv4 | IPv6 address. API for Ipv6 compatibility.

addr1 addr2

- Storage for IPv4 | IPv6 address - Storage for IPv4 | IPv6 address

Returns:
BOOL

- None

IO_ReadString

void IO_ReadString (Node* node node, const NodeInput* nodeInput, const char* index, BOOL* wasFound, char* readVal) Parameters:

This API is used to retrieve a string parameter value from input files.

node

- Node pointer for which string is - Pointer to node input.

nodeInput index

- Parameter name. - Storage for success of search.

wasFound readVal

- Storage for parameter value.

Returns:
void

- None

IO_CacheFile

void IO_CacheFile (const NodeInput* nodeInput, const char* filename) Parameters:

This API is used to read an auxiliary input file into a NodeInput struct Called for each file variable in the config file.

nodeInput filename

- Pointer to node input.

- Path to input file.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

void

- NULL

IO_GetMaxLen

int IO_GetMaxLen (fileName char*) Parameters:

This API is used to get the maximun length of a line in the file.

char*

- Pointer to the name of the file.

- Interger with the largest line length.

NI_GetMaxLen

int NI_GetMaxLen (nodeInput const NodeInput*) Parameters:

This API is used to get the maximun length of a line in nodeInput.

const NodeInput*

- Pointer to a node input.

Returns:
int

- Interger with the largest line length.

IO_ParseNetworkAddress

void IO_ParseNetworkAddress (const char s[], unsigned int* u_atmVal) Parameters:

Parses a string for a network address. Overloaded API for ATM compatibility.

s[]

- String to parse. - Storage for icd, aid, ptp

u_atmVal

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

IO_ConvertAddrToString

void IO_ConvertAddrToString (Address* address, char* addrStr) Parameters:

Convert generic address to appropriate network type address string format.

address addrStr

- generic address - address string

- atm_value need to be checked

Returns:
int

- None

IO_ReadString

void IO_ReadString (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

Parameters: This API is used to retrieve a string parameter value from input files.
node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadInt64

void IO_ReadInt64 (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, Int64* parameterValue) Parameters:

This API is used to retrieve a Int64 parameter value from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadTime

void IO_ReadTime (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, clocktype* parameterValue) Parameters:

This API is used to retrieve a clocktype parameter value from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterName wasFound

- Parameter name.

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadInt

void IO_ReadInt (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, int* parameterValue) Parameters:

This API is used to retrieve a Int parameter value from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadDouble

void IO_ReadDouble (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, double* parameterValue) Parameters:

This API is used to retrieve a double parameter value from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

IO_ReadCachedFile

void IO_ReadCachedFile (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, NodeInput* parameterValue) Parameters:

This API is used to retrieve a cached file parameter value from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadLine

void IO_ReadLine (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue) Parameters:

This API is used to retrieve a whole line from input files.

node

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadStringInstance

void IO_ReadStringInstance (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, char* parameterValue) Parameters:
node

This API is used to retrieve string parameter values from input files for a specific instance.

- node structure pointer.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

nodeId

- nodeId. - interface Index.

interfaceIndex nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadDoubleInstance

void IO_ReadDoubleInstance (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, double* parameterValue) Parameters:
node

This API is used to retrieve double parameter values from input files for a specific instance.

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadIntInstance

void IO_ReadIntInstance (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, int* parameterValue) Parameters:
node

This API is used to retrieve int parameter values from input files for a specific instance.

- node structure pointer.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

nodeId

- nodeId. - interface Index.

interfaceIndex nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadTimeInstance

void IO_ReadTimeInstance (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, clocktype* parameterValue) Parameters:
node

This API is used to retrieve clocktype parameter values from input files for a specific instance.

- node structure pointer. - nodeId. - interface Index.

nodeId

interfaceIndex nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadCachedFileInstance

void IO_ReadCachedFileInstance (Node* node, const NodeId nodeId, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, const int parameterInstanceNumber, const BOOL fallbackIfNoInstanceMatch, BOOL* wasFound, NodeInput* parameterValue) Parameters:
node

This API is used to retrieve cached file parameter values from input files for a

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

specific instance.

- node structure pointer.

nodeId

- nodeId. - interface Index.

interfaceIndex nodeInput

- Pointer to node input. - Parameter name. - Instance number. - Selects parameter without

parameterName

parameterInstanceNumber

fallbackIfNoInstanceMatch wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadStringUsingIpAddress

void IO_ReadStringUsingIpAddress (Node* node, int interfaceIndex, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue) Parameters:

This API is used to retrieve a string parameter value from input files using the ip-address.

node

- node structure pointer. - interface Index.

interfaceIndex nodeInput

- Pointer to node input. - Parameter name.

parameterName wasFound

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeAddress nodeId, NodeAddress ipv4Address, in6_addr* ipv6Address, const NodeInput* nodeInput, const char* parameterName, BOOL* wasFound, char* parameterValue) Parameters:

This API is used to retrieve a string parameter value from input files.

nodeId

- nodeId. - IP address of an interface - IPv6 address of an interface

ipv4Address ipv6Address nodeInput

- Pointer to node input.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

parameterName wasFound

- Parameter name.

- Storage for success of seach. - Storage for parameter value.

parameterValue

Returns:
void

- None

IO_ReadString

void IO_ReadString (const NodeAddress nodeId, int interfaceIndex, const NodeAddress ipv4SubnetAddress, const in6_addr* ipv6SubnetAddress, const NodeInput* nodeInput, const char* parameterName, char* parameterValue, BOOL& wasFound, int& matchType) Parameters:
nodeId

This API is used to retrieve a string parameter value from input files.

- nodeId. - interface index - IPv4 subnet address - IPv6 subnet address

interfaceIndex

ipv4SubnetAddress ipv6SubnetAddress nodeInput

- Pointer to node input. - Parameter name. - Storage for parameter value.

parameterName

parameterValue wasFound

- Storage for success of search. - Storage for matchType.

matchType

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

FILEIO

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/FILEIO.html[5/24/2011 12:34:20 PM]

GUI

EXata 2.2 API Specification

GUI
This file describes data structures and functions for interfacing with the QualNet GUI and the other graphical tools. Constant / Data Structure Summary Type
CONSTANT

Name
GUI_DEFAULT_STEP

The default interval before waiting for the Animator handshake/STEP.

CONSTANT GUI_DEFAULT_ICON

Icon used in case none is specified for a node.

CONSTANT MAX_LAYERS

By default, there are 8 layers, but users may add more

CONSTANT GUI_DEFAULT_DATA_TYPE

Default value to use for data types.

CONSTANT GUI_EMULATION_DATA_TYPE

Default value to use for data types.

CONSTANT GUI_DEFAULT_LINK_TYPE

Default value to use for link types.

CONSTANT GUI_DEFAULT_NODE_TYPE

Default value to use for node types.

CONSTANT GUI_DEFAULT_INTERFACE

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Default interface for GUI commands.

CONSTANT GUI_WIRELESS_LINK_TYPE

Used to distinguish wireless and wired links.

CONSTANT GUI_ATM_LINK_TYPE

Used to distinguish ATM links from other types.

CONSTANT GUI_COVERAGE_LINK_TYPE

Used by Stats Manager

CONSTANT GUI_MAX_COMMAND_LENGTH

Maximum length for a single interchange with Animator.

ENUMERATION GuiLayers

Layer in protocol stack. Allows animation filtering.

ENUMERATION GuiEvents

Semantic events to be animated.

ENUMERATION GuiStatisticsEvents

Statistics events recognized by Animator.

ENUMERATION GuiMetrics

Types of statistical metrics.

ENUMERATION GuiDataTypes

The numeric data types supported for dynamic statistics.

ENUMERATION GuiEffects

Animation effects that can be assigned to an event.

ENUMERATION GuiColors

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Colors that can be assigned to Animator effects.

ENUMERATION GuiSubnetTypes

Types of subnets recognized by the Animator.

ENUMERATION GuiCommands

Coded commands sent from Animator to Simulator.

ENUMERATION GuiReplies

Coded commands sent from Simulator to Animator.

ENUMERATION GuiReply

Structure containing message sent to Animator.

STRUCT MetricData

Class to identify a specific dynamic statistic.

STRUCT MetricLayerData

Contains a list of the metrics collected at a layer of the protocol stack.

STRUCT GuiCommand

Structure containing command received from Animator.

Function / Macro Summary Return Type

void

Summary
GUI_HandleHITLInput(const char * args, PartitionData * partition)

Called from GUI_EXTERNAL_ReceiveCommand() if command type is GUI_USER_DEFINED. Created so that GUI Human In the loop commands can also be given through a file, instead of giving it through the GUI. Will serve for good unit testing of GUI HITL commands
void GUI_Initialize(NodeInput* nodeInput, int numNodes, int coordinateSystem, Coordinates origin, Coordinates dimensions, clocktype maxClock)

Initializes the GUI in order to start the animation. The terrain map should give the path (either absolute, or relative to
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

QUALNET_HOME) of an file to represent the terrain.

void GUI_SetEffect(GuiEvents event, GuiLayers layer, int type, GuiEffects effect, GuiColors color)

This function will allow the protocol designer to specify the effect to use to display certain events.
void GUI_InitNode(Node* node, NodeInput* nodeInput, clocktype time)

Provides the initial location and orientation of the node, the transmission range (for wireless nodes), a node type, and optional icon and label.
void GUI_InitWirelessInterface(Node* node, int interfaceIndex)

Provides the initial location and orientation of the node, the transmission range (for wireless nodes), a node type, and optional icon and label.
void GUI_InitializeInterfaces(NodeInput* nodeInput)

Sets the IP address associated with one of the node's interfaces.

void GUI_SetInterfaceAddress(NodeId nodeID, NodeAddress interfaceAddress, int interfaceIndex, clocktype time)

Sets the IP address associated with one of the node's interfaces.

void GUI_SetSubnetMask(NodeId nodeID, NodeAddress interfaceAddress, int interfaceIndex, clocktype time)

Sets the Subnet mask associated with one of the node's interfaces.
void GUI_SetInterfaceName(NodeId nodeID, char* interfaceAddress, int interfaceIndex, clocktype time)

Sets the Interface name associated with one of the node's interfaces.
void GUI_MoveNode(NodeId nodeID, Coordinates position, clocktype time)

Moves the node to a new position.

void GUI_SetNodeOrientation(NodeId nodeID, Orientation orientation, clocktype time)

Changes the orientation of a node.

void GUI_SetNodeIcon(NodeId nodeID, char* iconFile, clocktype time)

Changes the icon associated with a node.

void GUI_SetNodeLabel(NodeId nodeID, char* label, clocktype time)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Changes the label (the node name) of a node.

void GUI_SetNodeRange(NodeId nodeID, int interfaceIndex, double range, clocktype time)

Changes the transmission range of a node

void GUI_SetNodeType(NodeId nodeID, int type, clocktype time)

Changes the (symbolic) type of a node

void GUI_SetPatternIndex(Node* node, int interfaceIndex, int index, clocktype time)

Sets the antenna pattern to one of a previously specified antenna pattern file.
void GUI_SetPatternAndAngle(node node*, int interfaceIndex, int index, int angleInDegrees, clocktype time)

For steerable antennas, it sets the pattern to use, and also an angle relative to the node's current orientation.
void GUI_AddLink(NodeId sourceID, NodeId destID, GuiLayers layer, int type, NodeAddress subnetAddress, int numHostBits, clocktype time)

Adds a link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.
void GUI_AddLink(NodeId sourceID, NodeId destID, GuiLayers layer, int type, int tla, int nla, int sla, clocktype time)

Adds an IPv6 link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.
void GUI_AddLink(NodeId sourceID, NodeId destID, GuiLayers layer, int type, IPv6subnetAddress ip6_addr, IPv6subnetPrefixLen unsigned int, clocktype time)

Adds an IPv6 link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.
void GUI_DeleteLink(NodeId sourceID, NodeId destID, GuiLayers layer, int type, clocktype time)

Removes link of a specific type.

void GUI_DeleteLink(NodeId sourceID, NodeId destID, GuiLayers layer, clocktype time)

Removes the aforementioned link, no matter the "type."

void GUI_Broadcast(NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time)

Indicates a broadcast.
void GUI_EndBroadcast(NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Indicates the end of a broadcast.

void GUI_Multicast(NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time)

Indicates a multicast. (Probably need to add a destination address.)

void GUI_Unicast(NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time)

Sends a unicast packet/frame/signal to a destination. Will probably be drawn as a temporary line between source and destination, followed by a signal (at the receiver) indicating success or failure.
void GUI_Receive(NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time)

Shows a successful receipt at a destination.

void GUI_Drop(NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time)

Shows a packet/frame/signal being dropped by a node.

void GUI_Collision(NodeId nodeID, GuiLayers layer, clocktype time)

Shows a node detecting a collision.

void GUI_CreateSubnet(GuiSubnetTypes type, NodeAddress subnetAddress, int numHostBits, const char* nodeList, clocktype time)

Creates a subnet. Normally done at startup.

void GUI_CreateSubnet(GuiSubnetTypes type, in6_addr IPv6subnetAddress, unsigned int IPv6subnetPrefixLen, const char* nodeList, clocktype time)

Creates a IPv6 subnet. Normally done at startup.

void GUI_CreateSubnet(GuiSubnetTypes type, IPv6subnetAddress ip6_addr, IPv6subnetPrefixLen unsigned int, const char* nodeList, clocktype time)

Creates a IPv6 subnet. Normally done at startup.

void GUI_CreateHierarchy(int componentID, char* nodeList)

Since the GUI supports hierarchical design, this function informs the GUI of the contents of a hierarchical component.
void GUI_MoveHierarchy(int hierarchyId, Coordinates centerCoordinates, Orientation orientation, clocktype time)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Moves the center point of a hierarchy to a new position.

void GUI_CreateWeatherPattern(int patternID, char* inputLine)

Sends the input line describing a weather pattern to the GUI.

void GUI_MoveWeatherPattern(int patternID, Coordinates coordinates, clocktype time)

Moves the first point of a weather pattern to a new position.

void GUI_AddApplication(NodeId sourceID, NodeId destID, char* appName, int uniqueId, clocktype time)

Shows label beside the client and the server as app link is setup.
void GUI_DeleteApplication(NodeId sourceID, NodeId destID, char* appName, int uniqueId, clocktype time)

Deletes the labels shown by AddApplication.

void GUI_AddInterfaceQueue(NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int queueSize, clocktype time)

Creates a queue for a node, interface and priority.

void GUI_QueueInsertPacket(NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int packetSize, clocktype time)

Inserting one packet to a queue for a node, interface and priority

void GUI_QueueDropPacket(NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, clocktype time)

Dropping one packet from a queue for a node, interface and priority.
void GUI_QueueDequeuePacket(NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int packetSize, clocktype time)

Dequeuing one packet from a queue for a node, interface and priority
int GUI_DefineMetric(char* name, NodeId nodeID, GuiLayers layer, int linkID, GuiDataTypes datatype, GuiMetrics metrictype)

This function defines a metric by giving it a name and a description. The system will assign a number to this data item. Future references to the data should use the number rather than the name. The link ID will be used to associate a metric with a particular application link, or MAC interface, etc.
void GUI_SendIntegerData(NodeId nodeID, int metricID, int value, clocktype time)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Sends data for an integer metric.

void GUI_SendUnsignedData(NodeId nodeID, int metricID, unsigned value, clocktype time)

Sends data for an unsigned metric.

void GUI_SendRealData(NodeId nodeID, int metricID, double value, clocktype time)

Sends data for a floating point metric.

bool GUI_isAnimateOrInteractive()

Returns true if the GUI was activated on the command line.

void GUI_EXTERNAL_Bootstrap(int argc, char** argv, NodeInput* nodeInput, int numberOfProcessors, int thisPartitionId)

Creates a connection to the GUI

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Structure

Class to identify a specific dynamic statistic. MetricLayerData

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Structure

Contains a list of the metrics collected at a layer of the protocol stack. GuiCommand

Structure containing command received from Animator.

Function / Macro Detail Function / Macro GUI_HandleHITLInput Format void GUI_HandleHITLInput (const char * args, PartitionData * partition) Parameters: Called from GUI_EXTERNAL_ReceiveCommand() if command type is GUI_USER_DEFINED. Created so that GUI Human In the loop commands can also be given through a file, instead of giving it through the GUI. Will serve for good unit testing of GUI HITL commands GUI_Initialize
args

- the command itself - the partition pointer

partition

Returns:
void

- NULL

void GUI_Initialize (NodeInput* nodeInput, int numNodes, int coordinateSystem, Coordinates origin, Coordinates dimensions, clocktype maxClock) Parameters:

Initializes the GUI in order to start the animation. The terrain map should give the path (either absolute, or relative to QUALNET_HOME) of an file to represent the terrain.

nodeInput numNodes

- configuration file

- the number of nodes in the simulation - LATLONALT or CARTESIAN

coordinateSystem origin

- Southwest corner - Northeast corner, or size

dimensions maxClock

- length of the simulation

Returns:
void

- NULL

GUI_SetEffect

void GUI_SetEffect (GuiEvents event, GuiLayers layer, int type, GuiEffects effect, GuiColors color) Parameters:

This function will allow the protocol designer

event

- the type of event for the new effect

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

to specify the effect to use to display certain events.

layer type

- the protocol layer

- special key to distinguish similar events - the effect to use

effect color

- optional color for the effect

Returns:
void

- NULL

GUI_InitNode

void GUI_InitNode (Node* node, NodeInput* nodeInput, clocktype time) Parameters:

Provides the initial location and orientation of the node, the transmission range (for wireless nodes), a node type, and optional icon and label.

node

- the node - configuration file

nodeInput time

- the current simulation time

Returns:
void

- NULL

GUI_InitWirelessInterface

void GUI_InitWirelessInterface (Node* node, int interfaceIndex) Parameters:

Provides the initial location and orientation of the node, the transmission range (for wireless nodes), a node type, and optional icon and label.

node

- the node - the interface to initialize

interfaceIndex

Returns:
void

- NULL

GUI_InitializeInterfaces

void GUI_InitializeInterfaces (NodeInput* nodeInput) Parameters:

Sets the IP address associated with one of the node's interfaces.

nodeInput

- configuration file

Returns:
void

- NULL

GUI_SetInterfaceAddress

void GUI_SetInterfaceAddress (NodeId nodeID, NodeAddress interfaceAddress, int interfaceIndex, clocktype time) Parameters:

Sets the IP address associated with one of the node's interfaces.

nodeID

- the node's ID

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

interfaceAddress interfaceIndex time

- new IP address

- interface Address to change

- the current simulation time

Returns:
void

- NULL

GUI_SetSubnetMask

void GUI_SetSubnetMask (NodeId nodeID, NodeAddress interfaceAddress, int interfaceIndex, clocktype time) Parameters:

Sets the Subnet mask associated with one of the node's interfaces.

nodeID

- the node's ID - new Subnet mask

interfaceAddress interfaceIndex time

- Subnet mask to change

- the current simulation time

Returns:
void

- NULL

GUI_SetInterfaceName

void GUI_SetInterfaceName (NodeId nodeID, char* interfaceAddress, int interfaceIndex, clocktype time) Parameters:

Sets the Interface name associated with one of the node's interfaces.

nodeID

- the node's ID - new Interface name

interfaceAddress interfaceIndex time

- interface Name to change

- the current simulation time

Returns:
void

- NULL

GUI_MoveNode

void GUI_MoveNode (NodeId nodeID, Coordinates position, clocktype time) Parameters:

Moves the node to a new position.

nodeID

- the node's ID - the new position

position time

- the current simulation time

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

GUI_SetNodeOrientation

void GUI_SetNodeOrientation (NodeId nodeID, Orientation orientation, clocktype time) Parameters:

Changes the orientation of a node.

nodeID

- the node's ID - the new orientation

orientation time

- the current simulation time

Returns:
void

- NULL

GUI_SetNodeIcon

void GUI_SetNodeIcon (NodeId nodeID, char* iconFile, clocktype time) Parameters:

Changes the icon associated with a node.

nodeID

- the node's ID - the path to the image file, may be the

iconFile time

- the current simulation time

Returns:
void

- NULL

GUI_SetNodeLabel

void GUI_SetNodeLabel (NodeId nodeID, char* label, clocktype time) Parameters:

Changes the label (the node name) of a node.

nodeID label time

- the node's ID

- a string to label the node

- the current simulation time

Returns:
void

- NULL

GUI_SetNodeRange

void GUI_SetNodeRange (NodeId nodeID, int interfaceIndex, double range, clocktype time) Parameters:

Changes the transmission range of a node

nodeID

- the node's ID - which of the node's interfaces to use

interfaceIndex range time

- the new transmission range in meters

- the current simulation time

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Returns:
void

- NULL

GUI_SetNodeType

void GUI_SetNodeType (NodeId nodeID, int type, clocktype time) Parameters:

Changes the (symbolic) type of a node

nodeID type time

- the node's ID

- user defined type, used with GUI_SetEffect - the current simulation time

Returns:
void

- NULL

GUI_SetPatternIndex

void GUI_SetPatternIndex (Node* node, int interfaceIndex, int index, clocktype time) Parameters:

Sets the antenna pattern to one of a previously specified antenna pattern file.

node

- the node pointer - which of the node's interfaces to use

interfaceIndex index time

- index into the node's antenna pattern file

- the current simulation time

Returns:
void

- NULL

GUI_SetPatternAndAngle

void GUI_SetPatternAndAngle (node node*, int interfaceIndex, int index, int angleInDegrees, clocktype time) Parameters:

For steerable antennas, it sets the pattern to use, and also an angle relative to the node's current orientation.

node*

- the node pointer - which of the node's interfaces to use

interfaceIndex index

- index into the node's antenna pattern file - angle to rotate the pattern

angleInDegrees time

- the current simulation time

Returns:
void

- NULL

GUI_AddLink

void GUI_AddLink (NodeId sourceID, NodeId destID, GuiLayers layer, int type, NodeAddress subnetAddress, int numHostBits, clocktype time)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Parameters: Adds a link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.
sourceID destID layer type

- the source node for the link

- the destination node

- the protocol layer associated w/ the link

- a user-defined type for the link - subnet address for network links

subnetAddress numHostBits time

- subnet size for network links

- the current simulation time

Returns:
void

- NULL

GUI_AddLink

void GUI_AddLink (NodeId sourceID, NodeId destID, GuiLayers layer, int type, int tla, int nla, int sla, clocktype time) Parameters:

Adds an IPv6 link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.

sourceID destID layer type tla nla sla

- the source node for the link

- the destination node

- the protocol layer associated w/ the link

- a user-defined type for the link

- TLA field of IPv6 address - NLA field of IPv6 address - SLA field of IPv6 address - the current simulation time

time

Returns:
void

- NULL

GUI_AddLink

void GUI_AddLink (NodeId sourceID, NodeId destID, GuiLayers layer, int type, IPv6subnetAddress ip6_addr, IPv6subnetPrefixLen unsigned int, clocktype time) Parameters:

Adds an IPv6 link (one hop on a route) between two nodes. In a wired topology, this could be a static route; in wireless, a dynamic one.

sourceID destID layer

- the source node for the link

- the destination node

- the protocol layer associated w/ the link

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

type

- a user-defined type for the link - IPv6 address - IPv6 address prefix length

ip6_addr

unsigned int time

- the current simulation time

Returns:
void

- NULL

GUI_DeleteLink

void GUI_DeleteLink (NodeId sourceID, NodeId destID, GuiLayers layer, int type, clocktype time) Parameters:

Removes link of a specific type.

sourceID destID layer type time

- the source node for the link

- the destination node

- the protocol layer associated w/ the link

- type of link being deleted - the current simulation time

Returns:
void

- NULL

GUI_DeleteLink

void GUI_DeleteLink (NodeId sourceID, NodeId destID, GuiLayers layer, clocktype time) Parameters:

Removes the aforementioned link, no matter the "type."

sourceID destID layer time

- the source node for the link

- the destination node

- the protocol layer associated w/ the link

- the current simulation time

Returns:
void

- NULL

GUI_Broadcast

void GUI_Broadcast (NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time) Parameters:

Indicates a broadcast.

nodeID layer type

- the node's ID

- the protocol layer associated w/ event

- a user-defined type for the link

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

interfaceIndex time

- which of the node's interfaces to use

- the current simulation time

Returns:
void

- NULL

GUI_EndBroadcast

void GUI_EndBroadcast (NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time) Parameters:

Indicates the end of a broadcast.

nodeID layer type

- the node's ID

- the protocol layer associated w/ event

- a user-defined type for the link - which of the node's interfaces to use

interfaceIndex time

- the current simulation time

Returns:
void

- NULL

GUI_Multicast

void GUI_Multicast (NodeId nodeID, GuiLayers layer, int type, int interfaceIndex, clocktype time) Parameters:

Indicates a multicast. (Probably need to add a destination address.)

nodeID layer type

- the node's ID

- the protocol layer associated w/ event

- a user-defined type for the link - which of the node's interfaces to use

interfaceIndex time

- the current simulation time

Returns:
void

- NULL

GUI_Unicast

void GUI_Unicast (NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time) Parameters:

Sends a unicast packet/frame/signal to a destination. Will probably be drawn as a temporary line between source and destination, followed by a signal (at the receiver) indicating success or failure.

sourceID destID layer

- the source node

- the destination node

- protocol layer associated w/ the event

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

type

- a user-defined type - sender's interface to use - receiver's interface to use

sendingInterfaceIndex

receivingInterfaceIndex time

- the current simulation time

Returns:
void

- NULL

GUI_Receive

void GUI_Receive (NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time) Parameters:

Shows a successful receipt at a destination.

sourceID destID layer type

- the source node

- the destination node

- protocol layer associated w/ the event

- a user-defined type - sender's interface to use - receiver's interface to use

sendingInterfaceIndex

receivingInterfaceIndex time

- the current simulation time

Returns:
void

- NULL

GUI_Drop

void GUI_Drop (NodeId sourceID, NodeId destID, GuiLayers layer, int type, int sendingInterfaceIndex, int receivingInterfaceIndex, clocktype time) Parameters:

Shows a packet/frame/signal being dropped by a node.

sourceID destID layer type

- the source node

- the destination node

- protocol layer associated w/ the event

- a user-defined type - sender's interface to use - receiver's interface to use

sendingInterfaceIndex

receivingInterfaceIndex time

- the current simulation time

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

void

- NULL

GUI_Collision

void GUI_Collision (NodeId nodeID, GuiLayers layer, clocktype time) Parameters:

Shows a node detecting a collision.

nodeID layer time

- the node's ID

- the protocol layer associated w/ event

- the current simulation time

Returns:
void

- NULL

GUI_CreateSubnet

void GUI_CreateSubnet (GuiSubnetTypes type, NodeAddress subnetAddress, int numHostBits, const char* nodeList, clocktype time) Parameters:

Creates a subnet. Normally done at startup.

type

- GUI_WIRED/WIRELESS/SATELLITE_NETWORK - base address for the subnet

subnetAddress numHostBits nodeList time

- number of host bits for subnet mask

- the rest of the .config file SUBNET line

- the current simulation time

Returns:
void

- NULL

GUI_CreateSubnet

void GUI_CreateSubnet (GuiSubnetTypes type, in6_addr IPv6subnetAddress, unsigned int IPv6subnetPrefixLen, const char* nodeList, clocktype time) Parameters:

Creates a IPv6 subnet. Normally done at startup.

type

- GUI_WIRED/WIRELESS/SATELLITE_NETWORK - base address for the subnet - number of network bits present

IPv6subnetAddress

IPv6subnetPrefixLen nodeList time

- the rest of the .config file SUBNET line

- the current simulation time

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

GUI_CreateSubnet

void GUI_CreateSubnet (GuiSubnetTypes type, IPv6subnetAddress ip6_addr, IPv6subnetPrefixLen unsigned int, const char* nodeList, clocktype time) Parameters:

Creates a IPv6 subnet. Normally done at startup.

type

- GUI_WIRED/WIRELESS/SATELLITE_NETWORK - IPv6 address - IPv6 address prefix length

ip6_addr

unsigned int nodeList time

- the rest of the .config file SUBNET line

- the current simulation time

Returns:
void

- NULL

GUI_CreateHierarchy

void GUI_CreateHierarchy (int componentID, char* nodeList) Parameters:

Since the GUI supports hierarchical design, this function informs the GUI of the contents of a hierarchical component.

componentID nodeList

- an identifier for the hierarchy

- the rest of the .config file COMPONENT line

Returns:
void

- NULL

GUI_MoveHierarchy

void GUI_MoveHierarchy (int hierarchyId, Coordinates centerCoordinates, Orientation orientation, clocktype time) Parameters:

Moves the center point of a hierarchy to a new position.

hierarchyId

- the hierarchy's ID - the new position

centerCoordinates orientation time

- the new orientation

- the current simulation time

Returns:
void

- NULL

GUI_CreateWeatherPattern

void GUI_CreateWeatherPattern (int patternID, char* inputLine) Parameters:

Sends the input line describing a weather pattern to the GUI.

patternID inputLine

- the weather pattern ID - the .weather file line

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Returns:
void

- NULL

GUI_MoveWeatherPattern

void GUI_MoveWeatherPattern (int patternID, Coordinates coordinates, clocktype time) Parameters:

Moves the first point of a weather pattern to a new position.

patternID

- the weather pattern ID - the new position

coordinates time

- the current simulation time

Returns:
void

- NULL

GUI_AddApplication

void GUI_AddApplication (NodeId sourceID, NodeId destID, char* appName, int uniqueId, clocktype time) Parameters:

Shows label beside the client and the server as app link is setup.

sourceID destID

- the source node

- the destination node - the application name, e.g. "CBR" - unique label for this application session

appName

uniqueId time

- the current simulation time

Returns:
void

- NULL

GUI_DeleteApplication

void GUI_DeleteApplication (NodeId sourceID, NodeId destID, char* appName, int uniqueId, clocktype time) Parameters:

Deletes the labels shown by AddApplication.

sourceID destID

- the source node

- the destination node - the application name, e.g. "CBR" - unique label for this application session

appName

uniqueId time

- the current simulation time

Returns:
void

- NULL

GUI_AddInterfaceQueue

void GUI_AddInterfaceQueue (NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int queueSize,

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

clocktype time) Parameters: Creates a queue for a node, interface and priority.
nodeID layer

- the node's ID

- protocol layer associated w/ the event - associated interface of node

interfaceIndex priority

- priority of queue - maximum size in bytes

queueSize time

- the current simulation time

Returns:
void

- NULL

GUI_QueueInsertPacket

void GUI_QueueInsertPacket (NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int packetSize, clocktype time) Parameters:

Inserting one packet to a queue for a node, interface and priority

nodeID layer

- the node's ID

- protocol layer associated w/ the event - associated interface of node

interfaceIndex priority

- priority of queue - size of packet

packetSize time

- the current simulation time

Returns:
void

- NULL

GUI_QueueDropPacket

void GUI_QueueDropPacket (NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, clocktype time) Parameters:

Dropping one packet from a queue for a node, interface and priority.

nodeID layer

- the node's ID

- protocol layer associated w/ the event - associated interface of node

interfaceIndex priority time

- priority of queue

- the current simulation time

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

Returns:
void

- NULL

GUI_QueueDequeuePacket

void GUI_QueueDequeuePacket (NodeId nodeID, GuiLayers layer, int interfaceIndex, unsigned priority, int packetSize, clocktype time) Parameters:

Dequeuing one packet from a queue for a node, interface and priority

nodeID layer

- the node's ID

- protocol layer associated w/ the event - associated interface of node

interfaceIndex priority

- priority of queue - size of packet

packetSize time

- the current simulation time

Returns:
void

- NULL

GUI_DefineMetric

int GUI_DefineMetric (char* name, NodeId nodeID, GuiLayers layer, int linkID, GuiDataTypes datatype, GuiMetrics metrictype) Parameters:

name

- the name of the metric - the node's ID

nodeID layer

- protocol layer associated w/ the event - e.g., an application session ID - real/unsigned/integer - cumulative/average, etc.

linkID

datatype

metrictype

Returns:
int

- an identifier associated the the metric name and layer

GUI_SendIntegerData

void GUI_SendIntegerData (NodeId nodeID, int metricID, int value, clocktype time) Parameters:

Sends data for an integer metric.

nodeID

- the node's ID - the value returned by DefineMetric

metricID value

- the current value of the metric

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

time

- the current simulation time

Returns:
void

- NULL

GUI_SendUnsignedData

void GUI_SendUnsignedData (NodeId nodeID, int metricID, unsigned value, clocktype time) Parameters:

Sends data for an unsigned metric.

nodeID

- the node's ID - the value returned by DefineMetric

metricID value time

- the current value of the metric

- the current simulation time

Returns:
void

- NULL

GUI_SendRealData

void GUI_SendRealData (NodeId nodeID, int metricID, double value, clocktype time) Parameters:

Sends data for a floating point metric.

nodeID

- the node's ID - the value returned by DefineMetric

metricID value time

- the current value of the metric

- the current simulation time

Returns:
void

- NULL

GUI_isAnimateOrInteractive

bool GUI_isAnimateOrInteractive () Parameters:

Returns true if the GUI was activated on the command line. GUI_EXTERNAL_Bootstrap

Returns:
bool

- True if the GUI is enabled.

void GUI_EXTERNAL_Bootstrap (int argc, char** argv, NodeInput* nodeInput, int numberOfProcessors, int thisPartitionId) Parameters:

Creates a connection to the GUI

argc argv

- number of command line parameters - command line parameters

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

GUI

nodeInput

- the contents of the .config file - the number of processors in use

numberOfProcessors thisPartitionId

- the ID of this partition

Returns:
void

- NULL

GUI_EXTERNAL_Registration

void GUI_EXTERNAL_Registration (PartitionData* partitionData, EXTERNAL_InterfaceList* list) Parameters:

Registers the GUI as an external interface

partitionData list

- the partition to register with

- the list to add oneself to

Returns:
void

- NULL

GUI_CreateReply

void GUI_CreateReply (GuiReplies replyType, std msg) Parameters:

Function used to replace newline characters in a string being sent to the GUI.

replyType msg

- the type of reply

- string*

Returns:
void

- NULL

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/GUI.html[5/24/2011 12:34:32 PM]

EXata 2.2 API Specification

IP
This file contains data structures and prototypes of functions used by IP. Constant / Data Structure Summary Type
CONSTANT

Name
IPVERSION4

Version of IP
CONSTANT IPTOS_LOWDELAY

Type of service ( low delay)

CONSTANT IPTOS_THROUGHPUT

Type of service ( throughput)

CONSTANT IPTOS_RELIABILITY

Type of service (reliability)

CONSTANT IPTOS_MINCOST

Type of service ( minimum cost)

CONSTANT IPTOS_ECT

Bits 6 and 7 in the IPv4 TOS octet are designated as the ECN field. Bit 6 is designated as the ECT bit.
CONSTANT IPTOS_CE

Bits 6 and 7 in the IPv4 TOS octet are designated as the ECN field. Bit 7 is designated as the CE bit.
CONSTANT IPTOS_DSCP_MAX

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Bits 0 to 5 in the IPv4 TOS octet are designated as DSCP field.The range for this 6-bit field is < 0 - 63 >.
CONSTANT IPTOS_DSCP_MIN

Bits 0 to 5 in the IPv4 TOS octet are designated as DSCP field.The range for this 6-bit field is < 0 - 63 >.
CONSTANT IPTOS_PREC_EFINTERNETCONTROL

IP precedence 'EF clasee internet control'

CONSTANT IPTOS_PREC_NETCONTROL

IP precedence 'net control'

CONSTANT IPTOS_PREC_INTERNETCONTROL

IP precedence 'internet control'

CONSTANT IPTOS_PREC_CRITIC_ECP

IP precedence 'critic ecp'

CONSTANT IPTOS_PREC_FLASHOVERRIDE

IP precedence 'flash override'

CONSTANT IPTOS_PREC_FLASH

IP precedence 'flash'
CONSTANT IPTOS_PREC_IMMEDIATE

IP precedence 'immediate'
CONSTANT IPTOS_PREC_PRIORITY

IP precedence 'priority'
CONSTANT IPTOS_PREC_ROUTINE

IP precedence 'routing'
CONSTANT IPTOS_PREC_INTERNETCONTROL_MIN_DELAY_SET

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IP precedence 'internet control'with the 'minimize delay' bit set

CONSTANT IPTOS_PREC_CRITIC_ECP_MIN_DELAY_SET

IP precedence 'critic ecp'with the 'minimize delay' bit set

CONSTANT IPOPT_CONTROL

IP option 'control'
CONSTANT IPOPT_RESERVED1

IP option 'reserved1'.
CONSTANT IPOPT_DEBMEAS

IP option 'debmeas'
CONSTANT IPOPT_RESERVED2

IP option 'reserved2'
CONSTANT IPOPT_EOL

IP option 'end of option list'.

CONSTANT IPOPT_NOP

IP option 'no operation'.

CONSTANT IPOPT_RR

IP option 'record packet route'.

CONSTANT IPOPT_TS

IP option 'timestamp'.
CONSTANT IPOPT_SECURITY

IP option ' provide s,c,h,tcc'.

CONSTANT IPOPT_LSRR

IP option 'loose source route'.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

CONSTANT

IPOPT_SATID

IP option 'satnet id'.

CONSTANT IPOPT_SSRR

IP option 'strict source route '.

CONSTANT IPOPT_TRCRT

IP option 'Traceroute'.
CONSTANT IPOPT_OPTVAL

Offset to IP option 'option ID'

CONSTANT IPOPT_OLEN

Offset to IP option 'option length'

CONSTANT IPOPT_OFFSET

Offset to IP option 'offset within option'

CONSTANT IPOPT_MINOFF

Offset to IP option 'min value of above'

CONSTANT IPOPT_TS_TSONLY

Flag bits for ipt_flg (timestamps only );

CONSTANT IPOPT_TS_TSANDADDR

Flag bits for ipt_flg (timestamps and addresses );

CONSTANT IPOPT_TS_PRESPEC

Flag bits for ipt_flg (specified modules only );

CONSTANT IPOPT_SECUR_UNCLASS

'unclass' bits for security in IP option field

CONSTANT IPOPT_SECUR_CONFID
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

'confid' bits for security in IP option field

CONSTANT IPOPT_SECUR_EFTO

'efto' bits for security in IP option field

CONSTANT IPOPT_SECUR_MMMM

'mmmm' bits for security in IP option field

CONSTANT IPOPT_SECUR_RESTR

'restr' bits for security in IP option field

CONSTANT IPOPT_SECUR_SECRET

'secreat' bits for security in IP option field

CONSTANT IPOPT_SECUR_TOPSECRET

'top secret' bits for security in IP option field

CONSTANT MAXTTL

Internet implementation parameters (maximum time to live (seconds) )

CONSTANT IPDEFTTL

Internet implementation parameters (default ttl, from RFC 1340 )

CONSTANT IPFRAGTTL

Internet implementation parameters (time to live for frags, slowhz )

CONSTANT IPTTLDEC

Internet implementation parameters (subtracted when forwarding)

CONSTANT IPDEFTOS

Internet implementation parameters (default TOS )

CONSTANT IP_MSS

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Internet implementation parameters ( default maximum segment size )

CONSTANT IPPROTO_IP

IP protocol numbers.
CONSTANT IPPROTO_ICMP

IP protocol numbers for ICMP.

CONSTANT IPPROTO_IAHEP

IP protocol numbers.
CONSTANT IPPROTO_OSPF

IP protocol numbers for OSPF .

CONSTANT IPPROTO_PIM

IP protocol numbers for PIM .

CONSTANT IPPROTO_RPIM

IP protocol numbers for PIM .

CONSTANT IPPROTO_IGRP

IP protocol numbers for IGRP .

CONSTANT IPPROTO_EIGRP

IP protocol numbers for EIGRP .

CONSTANT IPPROTO_BELLMANFORD

IP protocol numbers for BELLMANFORD.

CONSTANT IPPROTO_IPIP_RED

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IP protocol numbers for IP_RED.

CONSTANT IPPROTO_FISHEYE

IP protocol numbers for FISHEYE .

CONSTANT IPPROTO_FSRL

IP protocol numbers for LANMAR .

CONSTANT IPPROTO_ANODR

IP protocol numbers for ANODR .

CONSTANT IPPROTO_SECURE_NEIGHBOR

IP protocol numbers for secure neighbor discovery .

CONSTANT IPPROTO_SECURE_COMMUNITY

IP protocol numbers for secure routing community

CONSTANT IPPROTO_NETWORK_CES_CLUSTER

IP protocol numbers for clustering protocol.

CONSTANT IPPROTO_ROUTING_CES_ROSPF

IP protocol numbers for ROSPF protocol.

CONSTANT IPPROTO_IPIP_ROUTING_CES_MALSR

IP protocol numbers for MALSR IP encapsulation.

CONSTANT IPPROTO_IPIP_ROUTING_CES_ROSPF

IP protocol numbers for ROSPF IP encapsulation.

CONSTANT IPPROTO_NETWORK_CES_REGION

IP protocol numbers for RAP election protocol.

CONSTANT IPPROTO_MPR

IP protocol numbers for MPR

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

CONSTANT

IPPROTO_IPIP_ROUTING_CES_SRW

IP protocol numbers for ROUTING_CES_SRW IP encapsulation.

CONSTANT IPPROTO_IPIP_SDR

IP protocol numbers for SDR IP encapsulation.

CONSTANT IPPROTO_IPIP_SDR

IP protocol numbers for SDR IP encapsulation.

CONSTANT IPPROTO_MULTICAST_CES_SRW_MOSPF

IP protocol numbers for MULTICAST_CES_SRW_MOSPF IP encapsulation.

CONSTANT IPPROTO_CES_HSLS

IP protocol numbers for HSLS protocol.

CONSTANT IPPROTO_AODV

IP protocol numbers for AODV .

CONSTANT IPPROTO_DYMO

IP protocol numbers for DYMO .

CONSTANT IPPROTO_MAODV

IP protocol numbers for MAODV.

CONSTANT IPPROTO_DSR

IP protocol numbers for DSR .

CONSTANT IPPROTO_ODMRP

IP protocol numbers for ODMRP .

CONSTANT IPPROTO_LAR1

IP protocol numbers for LAR1.

CONSTANT IPPROTO_STAR
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IP protocol numbers for STAR.

CONSTANT IPPROTO_DAWN

IP protocol numbers for DAWN.

CONSTANT IPPROTO_EPLRS

IP protocol numbers for EPLRS protocol.

CONSTANT IPPROTO_EPLRS

IP protocol numbers for EPLRS protocol.

CONSTANT IPPROTO_CES_EPLRS_MPR

IP protocol numbers for EPLRS MPR protocol.

CONSTANT IPPROTO_DVMRP

IP protocol numbers for DVMRP.

CONSTANT IPPROTO_GSM

IP protocol numbers for GSM.

CONSTANT IPPROTO_EXTERNAL

IP protocol for external interface.

CONSTANT IPPROTO_INTERNET_GATEWAY

IP protocol numbers for Internet gateway for emulated nodes

CONSTANT IPPROTO_EXATA_VIRTUAL_LAN

IP protocol numbers for Internet gateway for emulated nodes

CONSTANT IPPROTO_NDP

IP protocol numbers for NDP.

CONSTANT IPPROTO_BRP

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IP protocol numbers for BRP .

CONSTANT IP_MIN_HEADER_SIZE

Minimum IP header size in bytes

CONSTANT IP_MAX_HEADER_SIZE

Maximum IP header size in bytes

CONSTANT IP_FRAGMENT_HOLD_TIME

Fragmented packets hold time.

CONSTANT IP_MIN_MULTICAST_ADDRESS

Used to determine whether an IP address is multicast.

CONSTANT IP_MAX_MULTICAST_ADDRESS

Used to determine whether an IP address is multicast.

CONSTANT MULTICAST_DEFAULT_INTERFACE_ADDRESS

Default multicast interface address (224.0.0.0).

CONSTANT IP_MIN_RESERVED_MULTICAST_ADDRESS

Minimum reserve multicast address (224.0.0.0).

CONSTANT IP_MAX_RESERVED_MULTICAST_ADDRESS

Maximum reserve multicast address (224.0.0.255).

CONSTANT MULTICAST_DEFAULT_NUM_HOST_BITS

Multicast default num host bit

CONSTANT NETWORK_UNREACHABLE

Network unreachable.
CONSTANT DEFAULT_INTERFACE

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Default interface index

CONSTANT NETWORK_IP_REASS_BUFF_TIMER

Max time data can stored in assembly buffer

CONSTANT MAX_IP_FRAGMENTS_SIMPLE_CASE

Max size of fragment allowed.

CONSTANT SMALL_REASSEMBLY_BUFFER_SIZE

Size of reassemble buffer

CONSTANT REASSEMBLY_BUFFER_EXPANSION_MULTIPLIER

Multiplier used for reassemble buffer expansion

ENUMERATION BackplaneType

NetworkIp backplane type(either CENTRAL or DISTRIBUTED)

STRUCT IpHeaderType

IpHeaderType is 20 bytes,just like in the BSD code.

STRUCT ip_timestamp

Time stamp option structure.

STRUCT ip_traceroute

TraceRoute option structure.

STRUCT NetworkIpBackplaneInfo

Structure maintaining IP Back plane Information

STRUCT ipHeaderSizeInfo

Structure maintaining IP header size Information

STRUCT NetworkMulticastForwardingTableRow

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Structure of an entity of multicast forwarding table.

STRUCT NetworkMulticastForwardingTable

Structure of multicast forwarding table

STRUCT NetworkIpMulticastGroupEntry

Structure for Multicast Group Entry

STRUCT IpPerHopBehaviorInfoType

Structure to maintain DS priority queue mapping

STRUCT IpMftcParameter

Variables of the structure define a unique condition class

STRUCT IpMultiFieldTrafficConditionerInfo

Structure used to store traffic condition.

STRUCT IpOptionsHeaderType

Structure of optional header for IP source route

STRUCT NetworkIpStatsType

Structure used to keep track of all stats of network layer.

STRUCT NetworkForwardingTableRow

Structure of an entity of forwarding table.

STRUCT NetworkForwardingTable

Structure of forwarding table.

STRUCT IpInterfaceInfoType

Structure for maintaining IP interface informations. This struct must be allocated by new, not MEM_malloc. All member variables MUST be initialized in the constructor.
STRUCT ip_frag_data

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

QualNet typedefs struct ip_frag_data to IpFragData. is a simple queue to hold fragmented packets.
STRUCT Ipv6FragQueue

Ipv6 fragment queue structure.

STRUCT FragmetedMsg

QualNet typedefs struct fragmeted_msg_struct to ip6q. struct fragmeted_msg_struct is a simple fragmented packets msg hold structure.
STRUCT NetworkDataIp;

Main structure of network layer.

STRUCT IpReassemblyBufferType

Structure of reassembly buffer

STRUCT IpReassemblyBufferListCellType

Structure of reassembly buffer cell listing

STRUCT IpReassemblyBufferListType

Structure of reassembly buffer list

Function / Macro Summary Return Type

MACRO

Summary
IPOPT_COPIED(o)

IP option 'copied'.
MACRO IPOPT_CLASS(o)

IP option 'class'
MACRO IPOPT_NUMBER(o)

IP option 'number'
MACRO IpHeaderSize(ipHeader)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Returns IP header ip_hl field * 4, which is the size of the IP header in bytes.
MACRO SetIpHeaderSize(IpHeader, Size)

Sets IP header ip_hl field (header length) to Size divided by 4

MACRO FragmentOffset(ipHeader)

Starting position of this fragment in actual packet.

MACRO SetFragmentOffset(ipHeader, offset)

To set offset of fragment.

void IpHeaderSetVersion()(UInt32* ip_v_hl_tos_len, unsigned int version)

Set the value of version number for IpHeaderType

void IpHeaderSetHLen()(UInt32* ip_v_hl_tos_len, unsigned int hlen)

Set the value of header length for IpHeaderType

void IpHeaderSetTOS()(UInt32* ip_v_hl_tos_len, unsigned int ipTos)

Set the value of Type of Service for IpHeaderType

void IpHeaderSetIpLength()(UInt32* ip_v_hl_tos_len, unsigned int ipLen)

Set the value of ip length for IpHeaderType

void IpHeaderSetIpFragOffset()(UInt16* ipFragment, UInt16 offset)

Set the value of ip_fragment_offset for IpHeaderType

void IpHeaderSetIpReserved()(UInt16* ipFragment, UInt16 ipReserved)

Set the value of ipReserved for IpHeaderType

void IpHeaderSetIpDontFrag()(UInt16* ipFragment, UInt16 dontFrag)

Set the value of ip_dont_fragment for IpHeaderType

void IpHeaderSetIpMoreFrag()(UInt16* ipFragment, UInt16 moreFrag)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Set the value of ip_more_fragment for IpHeaderType

unsigned int IpHeaderGetVersion()(UInt32 ip_v_hl_tos_len)

Returns the value of version number for IpHeaderType

unsigned int IpHeaderGetHLen()(UInt32 ip_v_hl_tos_len)

Returns the value of header length for IpHeaderType

unsigned int IpHeaderGetTOS()(UInt32 ip_v_hl_tos_len)

Returns the value of Type of Service for IpHeaderType

unsigned int IpHeaderGetIpLength()(UInt32 ip_v_hl_tos_len)

Returns the value of ip length for IpHeaderType

UInt16 IpHeaderGetIpFragOffset()(UInt16 ipFragment)

Returns the value of ip_fragment_offset for IpHeaderType

BOOL IpHeaderGetIpDontFrag()(UInt16 ipFragment)

Returns the value of ip_dont_fragment for IpHeaderType

BOOL IpHeaderGetIpMoreFrag()(UInt16 ipFragment)

Returns the value of ip_more_fragment for IpHeaderType

BOOL IpHeaderGetIpReserved()(UInt16 ipFragment)

Returns the value of ipReserved for IpHeaderType

void Ip_timestampSetFlag()(unsigned char flgOflw, unsigned char flag)

Set the value of flag for ip_timestamp_str

void Ip_timestampSetOvflw()(unsigned char flgOflw, unsigned char ovflw)

Set the value of ovflw for ip_timestamp_str

unsigned char Ip_timestampGetFlag()(unsigned char flgOflw)

Returns the value of flag for ip_timestamp_str

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

unsigned char

Ip_timestampGetOvflw()(unsigned char flgOflw)

Returns the value of overflow counter for ip_timestamp_str

NodeAddress ConvertNumHostBitsToSubnetMask(int numHostBits)

To generate subnetmask using number of host bit

int ConvertSubnetMaskToNumHostBits(NodeAddress subnetMask)

To generate number of host bit using subnetmask.

NodeAddress MaskIpAddress(NodeAddress address, NodeAddress mask)

To mask a ip address.
NodeAddress MaskIpAddressWithNumHostBits(NodeAddress address, int numHostBits)

To mask a ip address.
NodeAddress CalcBroadcastIpAddress(NodeAddress address, int numHostBits)

To generate broadcast address.

BOOL IsIpAddressInSubnet(NodeAddress address, NodeAddress subnetAddress, int numHostbits)

To check if a ip address belongs to a subnet.

void NetworkIpAddHeader(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl)

Add an IP packet header to a message. Just calls AddIpHeader.

IpOptionsHeaderType* FindAnIpOptionField(const IpHeaderType* ipHeader, const int optionKey)

Searches the IP header for the option field with option code that matches optionKey, and returns a pointer to the option field header.
void NetworkIpPreInit(Node* node)

IP initialization required before any of the other layers are initialized. This is mainly for MAC initialization, which requires certain IP structures be pre-initialized.
void NetworkIpInit(Node* node, const NodeInput* nodeInput)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Initialize IP variables, and all network-layer IP protocols..

void NetworkIpLayer(Node* node, Message* msg)

Handle IP layer events, incoming messages and messages sent to itself (timers, etc.).
void NetworkIpFinalize(Node* node)

Finalize function for the IP model. Finalize functions for all network-layer IP protocols are called here.
void NetworkIpReceivePacketFromTransportLayer(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, BOOL isEcnCapable)

Called by transport layer protocols (UDP, TCP) to send UDP datagrams and TCP segments using IP. Simply calls NetworkIpSendRawMessage().
void NetworkIpSendRawMessage(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl)

Called by NetworkIpReceivePacketFromTransportLayer() to send to send UDP datagrams, TCP segments using IP. Also called by network-layer routing protocols (AODV, OSPF, etc.) to send IP packets. This function adds an IP header and calls RoutePacketAndSendToMac().
void NetworkIpSendRawMessageWithDelay(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl, clocktype delay)

Same as NetworkIpSendRawMessage(), but schedules event after a simulation delay.

void NetworkIpSendRawMessageToMacLayer(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl, int interfaceIndex, NodeAddress nextHop)

Called by network-layer routing protocols (AODV, OSPF, etc.) to add an IP header to payload data, and with the resulting IP packet, calls NetworkIpSendPacketOnInterface().
void NetworkIpSendRawMessageToMacLayerWithDelay(Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl, int interfaceIndex, NodeAddress nextHop, clocktype delay)

Same as NetworkIpSendRawMessageToMacLayer(), but schedules the event after a simulation delay by calling NetworkIpSendPacketOnInterfaceWithDelay().
void NetworkIpSendPacketToMacLayer(Node* node, Message* msg, int interfaceIndex, NodeAddress nextHop)

This function is called once the outgoing interface index and next hop address to which to route an IP packet are known.
void NetworkIpSendPacketOnInterface(Node* node, Message* msg, int incomingInterface, int outgoingInterface, NodeAddress nextHop)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

This function is called once the outgoing interface index and next hop address to which to route an IP packet are known. This queues an IP packet for delivery to the MAC layer. This functions calls QueueUpIpFragmentForMacLayer(). This function is used to initiate fragmentation if required, but since fragmentation has been disabled, all it does is assert false if the IP packet is too big before calling the next function.
void NetworkIpSendPacketToMacLayerWithDelay(Node* node, Message* msg, int interfaceIndex, NodeAddress nextHop, clocktype delay)

Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay.

void NetworkIpSendPacketOnInterfaceWithDelay(Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop, clocktype delay)

Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay.

void NetworkIpSendRawPacketOnInterfaceWithDelay(Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop, clocktype delay)

Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay and denotes raw packet.
void NetworkIpSendPacketToMacLayerWithNewStrictSourceRoute(Node* node, Message* msg, NodeAddress[] newRouteAddresses, int numNewRouteAddresses, BOOL removeExistingRecordedRoute)

Tacks on a new source route to an existing IP packet and then sends the packet to the MAC layer.
void NetworkIpReceivePacketFromMacLayer(Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex)

IP received IP packet from MAC layer. Updates the Stats database and then calls NetworkIpReceivePacket.
void NetworkIpReceivePacket(Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex)

IP received IP packet. Determine whether the packet is to be delivered to this node, or needs to be forwarded. ipHeader->ip_ttl is decremented here, instead of the way BSD TCP/IP does it, which is to decrement TTL right before forwarding the packet. QualNet's alternative method suits its network-layer ad hoc routing protocols, which may do their own forwarding.
void NetworkIpNotificationOfPacketDrop(Node* node, Message* msg, NodeAddress nextHopNodeAddres, int interfaceIndex)

Invoke callback functions when a packet is dropped.

MacLayerStatusEventHandlerFunctionType NetworkIpGetMacLayerStatusEventHandlerFunction(Node* node, int interfaceIndex)

Get the status event handler function pointer.

void NetworkIpSetMacLayerStatusEventHandlerFunction(Node* node, MacLayerStatusEventHandlerFunctionType StatusEventHandlerPtr, int interfaceIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Allows the MAC layer to send status messages (e.g., packet drop, link failure) to a network-layer routing protocol for routing optimization.
void NetworkIpSneakPeekAtMacPacket(Node* node, const Message* msg, int interfaceIndex, NodeAddress prevHop)

Called Directly by the MAC layer, this allows a routing protocol to "sneak a peek" or "tap" messages it would not normally see from the MAC layer. This function will possibly unfragment such packets and call the function registered by the routing protocol to do the "Peek".
PromiscuousMessagePeekFunctionType NetworkIpGetPromiscuousMessagePeekFunction(Node* node, int interfaceIndex)

Returns the network-layer function which will promiscuously inspect packets. See NetworkIpSneakPeekAtMacPacket().
void NetworkIpSetPromiscuousMessagePeekFunction(Node* node, PromiscuousMessagePeekFunctionType PeekFunctionPtr, int interfaceIndex)

Sets the network-layer function which will promiscuously inspect packets. See NetworkIpSneakPeekAtMacPacket().
void NetworkIpReceiveMacAck(Node* node, int interfaceIndex, const Message* msg, NodeAddress nextHop)

MAC received an ACK, so call ACK handler function.

MacLayerAckHandlerType NetworkIpGetMacLayerAckHandler(Node* node, int interfaceIndex)

Get MAC layer ACK handler

void NetworkIpSetMacLayerAckHandler(Node* node, MacLayerAckHandlerType macAckHandlerPtr, int interfaceIndex)

Set MAC layer ACK handler

void SendToUdp(Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, int incomingInterfaceIndex)

Sends a UDP packet to UDP in the transport layer. The source IP address, destination IP address, and priority of the packet are also sent.
void SendToTcp(Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, BOOL aCongestionExperienced)

Sends a TCP packet to TCP in the transport layer. The source IP address, destination IP address, and priority of the packet are also sent..
void SendToRsvp(Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, int interfaceIndex, unsigned ttl)

Sends a RSVP packet to RSVP in the transport layer. The source IP address, destination IP address, and priority of the packet are
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

also sent.
void NetworkIpRemoveIpHeader(Node* node, Message* msg, NodeAddress* sourceAddress, NodeAddress* destinationAddress, TosType* priority, unsigned char* protocol, unsigned* ttl)

Removes the IP header from a message while also returning all the fields of the header.
void AddIpOptionField(Node* node, Message* msg, int optionCode, int optionSize)

Inserts an option field in the header of an IP packet.

void ExtractIpSourceAndRecordedRoute(Message* msg, NodeAddress[] RouteAddresses, int* NumAddresses, int* RouteAddressIndex)

Retrieves a copy of the source and recorded route from the options field in the header.
RouterFunctionType NetworkIpGetRouterFunction(Node* node, int interfaceIndex)

Get the router function pointer.

void NetworkIpSetRouterFunction(Node* node, RouterFunctionType RouterFunctionPtr, int interfaceIndex)

Allows a routing protocol to set the "routing function" (one of its functions) which is called when a packet needs to be routed. NetworkIpSetRouterFunction() allows a routing protocol to define the routing function. The routing function is called by the network layer to ask the routing protocol to route the packet. The routing function is given the packet and its destination. The routing protocol can route the packet and set "PacketWasRouted" to TRUE; or not route the packet and set to FALSE. If the packet, was not routed, then the network layer will try to use the forwarding table or the source route the source route in the IP header. This function will also be given packets for the local node the routing protocols can look at packets for protocol reasons. In this case, the message should not be modified and PacketWasRouted must be set to FALSE.
void NetworkIpAddUnicastRoutingProtocolType(Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex)

Add unicast routing protocol type to interface.

void NetworkIpAddUnicastIntraRegionRoutingProtocolType(Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex)

Add unicast intra region routing protocol type to interface.

void* NetworkIpGetRoutingProtocol(Node* node, NetworkRoutingProtocolType routingProtocolType)

Get routing protocol structure associated with routing protocol running on this interface.
NetworkRoutingProtocolType NetworkIpGetUnicastRoutingProtocolType(Node* node, int interfaceIndex)

Get unicast routing protocol type on this interface.

void
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

(Node* node, int interfaceIndex)

NetworkIpSetHsrpOnInterface

To enable hsrp on a interface

BOOL NetworkIpIsHsrpEnabled(Node* node, int interfaceIndex)

To test if any interface is hsrp enabled.

void NetworkIpAddNewInterface(Node* node, NodeAddress interfaceIpAddress, int numHostBits, int* newInterfaceIndex, const NodeInput* nodeInput)

Add new interface to node.

void NetworkIpInitCpuQueueConfiguration(Node* node, const NodeInput* nodeInput)

Initializes cpu queue parameters during startup.

void NetworkIpInitInputQueueConfiguration(Node* node, const NodeInput* nodeInput, int interfaceIndex)

Initializes input queue parameters during startup.

void NetworkIpInitOutputQueueConfiguration(Node* node, const NodeInput* nodeInput, int interfaceIndex)

Initializes queue parameters during startup.

void NetworkIpCreateQueues(Node* node, const NodeInput* nodeInput, int interfaceIndex)

Initializes input and output queue parameters during startup

void NetworkIpSchedulerParameterInit(Scheduler* schedulerPtr, const int numPriorities, Queue* queue)

Initialize the scheduler parameters and also allocate memory for queues if require.
void NetworkIpSchedulerInit(Node* node, const NodeInput* nodeInput, int interfaceIndex, Scheduler* schedulerPtr, const char* schedulerTypeString)

Call initialization function for appropriate scheduler.

void NetworkIpCpuQueueInsert(Node* node, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull, int incomingInterface)

Calls the cpu packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IP address. The packet's priority value is also returned.
void NetworkIpInputQueueInsert(Node* node, int incomingInterface, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Calls input packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IP address. The packet's priority value is also returned.
void NetworkIpOutputQueueInsert(Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull)

Calls output packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IP address. The packet's priority value is also returned. Called by QueueUpIpFragmentForMacLayer().
BOOL NetworkIpInputQueueDequeuePacket(Node* node, int incomingInterface, Message** msg, NodeAddress* nextHopAddress, int* outgoingInterface, int* networkType, QueuePriorityType* priority)

Calls the packet scheduler for an interface to retrieve an IP packet from the input queue associated with the interface.
BOOL NetworkIpOutputQueueDequeuePacket(Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, QueuePriorityType* priority)

Calls the packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IP address. The packet's priority value is also returned. This function is called by MAC_OutputQueueDequeuePacket() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpOutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, QueuePriorityType priority, Message** msg, NodeAddress* nextHopAddress, int* networkType, int posInQueue)

Same as NetworkIpOutputQueueDequeuePacket(), except the packet dequeued is requested by a specific priority, instead of leaving the priority decision up to the packet scheduler. This function is called by MAC_OutputQueueDequeuePacketForAPriority() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpOutputQueueDequeuePacketWithIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType)

Same as NetworkIpOutputQueueDequeuePacket(), except the packet dequeued is requested by a specific index This function is called by MAC_OutputQueueDequeuePacketForAPriority() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpInputQueueTopPacket(Node* node, int incomingInterface, Message** msg, NodeAddress* nextHopAddress, int* outgoingInterface, int* networkType, QueuePriorityType* priority)

Same as NetworkIpInputQueueDequeuePacket(), except the packet is not actually dequeued. Note that the message containing the packet is not copied; the contents may (inadvertently or not) be directly modified.
BOOL NetworkIpOutputQueueTopPacket(Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, QueuePriorityType* priority)

Same as NetworkIpOutputQueueDequeuePacket(), except the packet is not actually dequeued. Note that the message containing the
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

packet is not copied; the contents may (inadvertently or not) be directly modified. This function is called by MAC_OutputQueueTopPacket() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpOutputQueuePeekWithIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress* nextHopAddress, QueuePriorityType* priority)

Same as NetworkIpOutputQueueDequeuePacket(), except the packet is not actually dequeued. Note that the message containing the packet is not copied; the contents may (inadvertently or not) be directly modified. This function is called by MAC_OutputQueueTopPacket() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpOutputQueueTopPacketForAPriority(Node* node, int interfaceIndex, QueuePriorityType priority, Message** msg, NodeAddress* nextHopAddress, int posInQueue)

Same as NetworkIpOutputQueueDequeuePacketForAPriority(), except the packet is not actually dequeued. Note that the message containing the packet is not copied; the contents may (inadvertently or not) be directly modified. This function is called by MAC_OutputQueueTopPacketForAPriority() (mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.
BOOL NetworkIpInputQueueIsEmpty(Node* node, int incomingInterface)

Calls the packet scheduler for an interface to determine whether the interface's input queue is empty
BOOL NetworkIpOutputQueueIsEmpty(Node* node, int interfaceIndex)

Calls the packet scheduler for an interface to determine whether the interface's output queue is empty.
int NetworkIpOutputQueueNumberInQueue(Node* node, int interfaceIndex, BOOL specificPriorityOnly, QueuePriorityType priority)

Calls the packet scheduler for an interface to determine how many packets are in a queue. There may be multiple queues on an interface, so the priority of the desired queue is also provided.
NodeAddress NetworkIpOutputQueueDropPacket(Node* node, int interfaceIndex, Message** msg)

Drop a packet from the queue.

void NetworkIpDeleteOutboundPacketsToANode(Node* node, const NodeAddress nextHopAddress, const NodeAddress destinationAddress, const BOOL returnPacketsToRoutingProtocol)

Deletes all packets in the queue going (probably broken), to the specified next hop address. There is option to return all such packets back to the routing protocols. via the usual mechanism (callback).
unsigned GetQueueNumberFromPriority(TosType userTos, int numQueues)

Get queue number through which a given user priority will be forwarded.
QueuePriorityType ReturnPriorityForPHB(Node* node, TosType tos)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Returns the priority queue corresponding to the DS/TOS field.

void NetworkGetInterfaceAndNextHopFromForwardingTable(Node* node, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress)

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).
void NetworkGetInterfaceAndNextHopFromForwardingTable(Node* node, int currentInterface, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress)

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).
void NetworkGetInterfaceAndNextHopFromForwardingTable(Node* node, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress, BOOL testType, NetworkRoutingProtocolType type)

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).
void NetworkGetInterfaceAndNextHopFromForwardingTable(Node* node, int operatingInterface, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress, BOOL testType, NetworkRoutingProtocolType type)

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).
int NetworkIpGetInterfaceIndexForNextHop(Node* node, NodeAddress nextHopAddress)

This function looks at the network address of each of a node's network interfaces. When nextHopAddress is matched to a network, the interface index corresponding to the network is returned. (used by NetworkUpdateForwardingTable() and ospfv2.pc)
int NetworkGetInterfaceIndexForDestAddress(Node* node, NodeAddress destAddress)

Get interface for the destination address.

NetworkRoutingAdminDistanceType NetworkRoutingGetAdminDistance(Node* node, NetworkRoutingProtocolType type)

Get the administrative distance of a routing protocol. These values don't quite match those recommended by Cisco.
void NetworkInitForwardingTable(Node* node)

Initialize the IP fowarding table, allocate enough memory for number of rows.
void NetworkUpdateForwardingTable(Node* node, NodeAddress destAddress, NodeAddress destAddressMask, NodeAddress nextHopAddress, int outgoingInterfaceIndex, int cost, NetworkRoutingProtocolType type)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Update or add entry to IP routing table. Search the routing table for an entry with an exact match for destAddress, destAddressMask, and routing protocol. Update this entry with the specified nextHopAddress (the outgoing interface is automatically determined from the nextHopAddress -- see code). If no matching entry found, then add a new route.
void NetworkRemoveForwardingTableEntry(Node* node, NodeAddress destAddress, NodeAddress destAddressMask, NodeAddress nextHopAddress, int outgoingInterfaceIndex)

Remove single entries in the routing table

void NetworkEmptyForwardingTable(Node* node, NetworkRoutingProtocolType type)

Remove entries in the routing table corresponding to a given routing protocol.

void NetworkPrintForwardingTable(Node* node)

Display all entries in node's routing table.

int NetworkGetMetricForDestAddress(Node* node, NodeAddress destAddress)

Get the cost metric for a destination from the forwarding table.
void NetworkIpSetRouteUpdateEventFunction(Node* node, NetworkRouteUpdateEventType routeUpdateFunctionPtr)

Set a callback fuction when a route changes from forwarding table.

NetworkRouteUpdateEventType NetworkIpGetRouteUpdateEventFunction(Node* node)

Print packet headers when packet tracing is enabled.

NodeAddress NetworkIpGetInterfaceAddress(Node* node, int interfaceIndex)

Get the interface address on this interface

char* NetworkIpGetInterfaceName(Node* node, int interfaceIndex)

To get the interface name associated with the interface

NodeAddress NetworkIpGetInterfaceNetworkAddress(Node* node, int interfaceIndex)

To get network address associated with interface

NodeAddress NetworkIpGetInterfaceSubnetMask(Node* node, int interfaceIndex)

To retrieve subnet mask of the node interface

int NetworkIpGetInterfaceNumHostBits(Node* node, int interfaceIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Get the number of host bits on this interface

NodeAddress NetworkIpGetInterfaceBroadcastAddress(Node* node, int interfaceIndex)

Get broadcast address on this interface

BOOL IsOutgoingBroadcast(Node* node, NodeAddress destAddress, int* outgoingInterface, NodeAddress* outgoingBroadcastAddress)

Checks whether IP packet's destination address is broadcast

BOOL NetworkIpIsMyIP(Node* node, NodeAddress ipAddress)

In turn calls IsMyPacket()

void NetworkIpConfigurationError(Node* node, char [] parameterName, int interfaceIndex)

Prints out the IP configuration error

void NetworkPrintIpHeader(Message* msg)

To print the IP header

void NetworkIpAddToMulticastGroupList(Node* node, NodeAddress groupAddress)

Add a specified node to a multicast group

void NetworkIpRemoveFromMulticastGroupList(Node* node, NodeAddress groupAddress)

To remove specified node from a multicast group

void NetworkIpPrintMulticastGroupList(Node* node)

To print the multicast grouplist

BOOL NetworkIpIsPartOfMulticastGroup(Node* node, NodeAddress groupAddress)

check if a node is part of specified multicast group

void NetworkIpJoinMulticastGroup(Node* node, NodeAddress mcastAddr, clocktype delay)

To join a multicast group

void NetworkIpJoinMulticastGroup(Node* node, NodeAddress mcastAddr, clocktype delay)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

To join a multicast group

void NetworkIpLeaveMulticastGroup(Node* node, NodeAddress mcastAddr, clocktype delay)

To leave a multicast group

void NetworkIpLeaveMulticastGroup(Node* node, NodeAddress mcastAddr, clocktype delay)

To leave a multicast group

void NetworkIpSetMulticastTimer(Node* node, long eventType, NodeAddress mcastAddr, clocktype delay)

To set a multicast timer to join or leave multicast groups

void NetworkIpSetMulticastRoutingProtocol(Node* node, void* multicastRoutingProtocol, int interfaceIndex)

Assign a multicast routing protocol to an interface

void * NetworkIpGetMulticastRoutingProtocol(Node* node, NetworkRoutingProtocolType routingProtocolType)

To get the Multicast Routing Protocol structure

void NetworkIpAddMulticastRoutingProtocolType(Node* node, NetworkRoutingProtocolType multicastProtocolType, int interfaceIndex)

Assign a multicast protocol type to an interface

void NetworkIpSetMulticastRouterFunction(Node* node, MulticastRouterFunctionType routerFunctionPtr, int interfaceIndex)

Set a multicast router function to an interface

MulticastRouterFunctionType NetworkIpGetMulticastRouterFunction(Node* node, int interfaceIndex)

Get the multicast router function for an interface

void NetworkIpUpdateMulticastRoutingProtocolAndRouterFunction(Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex)

Assign multicast routing protocol structure and router function to an interface. We are only allocating the multicast routing protocol structure and router function once by using pointers to the original structures.
void NetworkIpUpdateUnicastRoutingProtocolAndRouterFunction(Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Assign unicast routing protocol structure and router function to an interface. We are only allocating the unicast routing protocol structure and router function once by using pointers to the original structures.
int NetworkIpGetInterfaceIndexFromAddress(Node* node, NodeAddress address)

Get the interface index from an IP address.

int NetworkIpGetInterfaceIndexFromSubnetAddress(Node* node, NodeAddress address)

Get the interface index from an IP subnet address.

BOOL NetworkIpIsMulticastAddress(Node* node, NodeAddress address)

Check if an address is a multicast address.

void NetworkInitMulticastForwardingTable(Node* node)

initialize the multicast fowarding table, allocate enough memory for number of rows, used by ip
void NetworkEmptyMulticastForwardingTable(Node* node)

empty out all the entries in the multicast forwarding table. basically set the size of table back to 0.
LinkedList* NetworkGetOutgoingInterfaceFromMulticastForwardingTable(Node* node, NodeAddress sourceAddress, NodeAddress groupAddress)

get the interface Id node that lead to the (source, multicast group) pair.
void NetworkUpdateMulticastForwardingTable(Node* node, NodeAddress sourceAddress, NodeAddress multicastGroupAddress, int interfaceIndex)

update entry with(sourceAddress,multicastGroupAddress) pair. search for the row with(sourceAddress,multicastGroupAddress) and update its interface.
void NetworkPrintMulticastForwardingTable(Node* node)

display all entries in multicast forwarding table of the node.

void NetworkPrintMulticastOutgoingInterface(Node* node, list* list)

Print mulitcast outgoing interfaces.

BOOL NetworkInMulticastOutgoingInterface(Node* node, List* list, int interfaceIndex)

Determine if interface is in multicast outgoing interface list.

void NetworkIpPrintTraceXML(Node* node, Message* msg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Print packet trace information in XML format.

void RouteThePacketUsingLookupTable(Node* node, Message* msg, int incomingInterface)

Tries to route and send the packet using the node's forwarding table.
int GetNetworkIPFragUnit(Node* node, int interfaceIndex)

Returns the network ip fragmentation unit.

void NetworkIpUserProtocolInit(Node* node, const NodeInput* nodeInput, const char* routingProtocolString, NetworkRoutingProtocolType* routingProtocolType, void** routingProtocolData)

Initialization of user protocol(disabled)

void NetworkIpUserHandleProtocolEvent(Node* node, Message* msg)

Event handler function of user protocol(disabled)

void NetworkIpUserHandleProtocolPacket(Node* node, Message* msg, unsigned char ipProtocol, NodeAddress sourceAddress, NodeAddress destinationAddress, int ttl)

Process a user protocol generated control packet(disabled)

void NetworkIpUserProtocolFinalize(Node* node, int userProtocolNumber)

Finalization of user protocol(disabled)

void Atm_RouteThePacketUsingLookupTable(Node* node, NodeAddress* destAddr, int* outIntf, NodeAddress* nextHop)

Routing packet received at ATM node

void RouteThePacketUsingMulticastForwardingTable(Node* node, Message* msg, int incomingInterface)

Tries to route the multicast packet using the multicast forwarding table.
int NETWORKIpRoutingInit(Node * node, const NodeInput *nodeInput nodeInput)

Initialization function for network layer. Initializes IP.

Int64 NetworkIpGetBandwidth(Node* node, int interfaceIndex)

getting the bandwidth information

clocktype NetworkIpGetPropDelay(Node* node, int interfaceIndex)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

getting the propagation delay information

BOOL NetworkIpInterfaceIsEnabled(Node* node, int interfaceIndex)

To check the interface is enabled or not?

BOOL NetworkIpIsWiredNetwork(Node* node, int interfaceIndex)

Determines if an interface is a wired interface.

BOOL NetworkIpIsPointToPointNetwork(Node* node, int interfaceIndex)

Determines if an interface is a point-to-point.

BOOL IsIPV4MulticastEnabledOnInterface(Node* node, int interfaceIndex)

To check if IPV4 Multicast is enabled on interface?

BOOL IsIPV4RoutingEnabledOnInterface(Node* node, int interfaceIndex)

To check if IPV4 Routing is enabled on interface?

NetworkProtocolType NetworkIpGetNetworkProtocolType(Node* node, NodeAddress nodeId)

Get Network Protocol Type for the node

NetworkType ResolveNetworkTypeFromSrcAndDestNodeId(Node* node, NodeId sourceNodeId, NodeId destNodeId)

Resolve the NetworkType from source and destination node id's.

BOOL NetworkIpIsWiredBroadcastNetwork(Node* node, int interfaceIndex)

Determines if an interface is a wired interface.

ip_traceroute* FindTraceRouteOption(const IpHeaderType* ipHeader)

Searches the IP header for the Traceroute option field , and returns a pointer to traceroute header.

Constant / Data Structure Detail

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Constant

IPVERSION4 4

Constant

Bits 6 and 7 in the IPv4 TOS octet are designated as the ECN field. Bit 7 is designated as the CE bit. IPTOS_DSCP_MAX 0x3f

Constant

Bits 0 to 5 in the IPv4 TOS octet are designated as DSCP field.The range for this 6-bit field is < 0 - 63 >. IPTOS_DSCP_MIN 0x00

Constant

Bits 0 to 5 in the IPv4 TOS octet are designated as DSCP field.The range for this 6-bit field is < 0 - 63 >. IPTOS_PREC_EFINTERNETCONTROL 0xb8

Constant

IP precedence 'EF clasee internet control' IPTOS_PREC_NETCONTROL 0xe0

'unclass' bits for security in IP option field IPOPT_SECUR_CONFID 0xf135

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Constant

IP protocol for external interface. IPPROTO_INTERNET_GATEWAY 240

Constant

IP protocol numbers for Internet gateway for emulated nodes IPPROTO_EXATA_VIRTUAL_LAN 241

Constant

IP protocol numbers for Internet gateway for emulated nodes IPPROTO_NDP 255

NetworkIp backplane type(either CENTRAL or DISTRIBUTED) IpHeaderType

Structure

Structure of optional header for IP source route NetworkIpStatsType

Structure

Structure of reassembly buffer IpReassemblyBufferListCellType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Structure

Structure of reassembly buffer cell listing IpReassemblyBufferListType

Structure of reassembly buffer list

Function / Macro Detail Function / Macro IPOPT_COPIED(o) Format IP option 'copied'.

IPOPT_CLASS(o)

IP option 'class'

IPOPT_NUMBER(o)

IP option 'number'

IpHeaderSize(ipHeader)

Returns IP header ip_hl field * 4, which is the size of the IP header in bytes.

SetIpHeaderSize(IpHeader, Size)

Sets IP header ip_hl field (header length) to Size divided by 4

FragmentOffset(ipHeader)

Starting position of this fragment in actual packet.

SetFragmentOffset(ipHeader, offset)

To set offset of fragment.

IpHeaderSetVersion()

void IpHeaderSetVersion() (UInt32* ip_v_hl_tos_len, unsigned int version) Parameters:

Set the value of version number for IpHeaderType

ip_v_hl_tos_len version

- The variable containing the value of ip_v

- Input value for set operation

Returns:
void

- None

IpHeaderSetHLen()

void IpHeaderSetHLen() (UInt32* ip_v_hl_tos_len, unsigned int hlen) Parameters:

Set the value of header length for IpHeaderType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

ip_v_hl_tos_len

- The variable containing the value of ip_v

- The variable containing the value of - Input value for set operation

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IpHeaderSetIpDontFrag()

void IpHeaderSetIpDontFrag() (UInt16* ipFragment, UInt16 dontFrag) Parameters:

Set the value of ip_dont_fragment for IpHeaderType

ipFragment dontFrag

- The variable containing the value of

- Input value for set operation

Returns:
void

- None

IpHeaderSetIpMoreFrag()

void IpHeaderSetIpMoreFrag() (UInt16* ipFragment, UInt16 moreFrag) Parameters:

Set the value of ip_more_fragment for IpHeaderType

ipFragment moreFrag

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

flgOflw

- The variable containing the value of flag and

flag

- Input value for set operation

Returns:
void

- None

Ip_timestampSetOvflw()

void Ip_timestampSetOvflw() (unsigned char flgOflw, unsigned char ovflw) Parameters:

Set the value of ovflw for ip_timestamp_str

flgOflw ovflw

- The variable containing the value of flag and

- Input value for set operation

Returns:
void

- None

Ip_timestampGetFlag()

unsigned char Ip_timestampGetFlag() (unsigned char flgOflw) Parameters:

Returns the value of flag for ip_timestamp_str

flgOflw

- The variable containing the value of flag and

Returns:
unsigned char

- None

Ip_timestampGetOvflw()

unsigned char Ip_timestampGetOvflw() (unsigned char flgOflw) Parameters:

Returns the value of overflow counter for ip_timestamp_str

flgOflw

- The variable containing the value of flag and

Returns:
unsigned char

- None

ConvertNumHostBitsToSubnetMask

NodeAddress ConvertNumHostBitsToSubnetMask (int numHostBits) Parameters:

To generate subnetmask using number of host bit

numHostBits

- number of host bit.

Returns:
NodeAddress

- subnetmask

ConvertSubnetMaskToNumHostBits

int ConvertSubnetMaskToNumHostBits (NodeAddress subnetMask) Parameters:

To generate number of host bit using subnetmask.

subnetMask

- subnetmask.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

int

- number of host bit.

MaskIpAddress

NodeAddress MaskIpAddress (NodeAddress address, NodeAddress mask) Parameters:

To mask a ip address.

address mask

- address of a node

- mask of subnet.

Returns:
NodeAddress

- masked node address.

MaskIpAddressWithNumHostBits

NodeAddress MaskIpAddressWithNumHostBits (NodeAddress address, int numHostBits) Parameters:

To mask a ip address.

address

- address of a node. - number of host bit.

numHostBits

Returns:
NodeAddress

- masked node address.

CalcBroadcastIpAddress

NodeAddress CalcBroadcastIpAddress (NodeAddress address, int numHostBits) Parameters:

To generate broadcast address.

address

- address of a node. - number of host bit.

numHostBits

Returns:
NodeAddress

- Broadcast address.

IsIpAddressInSubnet

BOOL IsIpAddressInSubnet (NodeAddress address, NodeAddress subnetAddress, int numHostbits) Parameters:

To check if a ip address belongs to a subnet.

address

- address of a node. - address of a subnet.

subnetAddress numHostbits

- number of host bit.

Returns:
BOOL

- TRUE if ip address belongs to a subnet else FALSE.

NetworkIpAddHeader
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

void NetworkIpAddHeader (Node* node, Message* msg, NodeAddress sourceAddress,

NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl) Parameters: Add an IP packet header to a message. Just calls AddIpHeader.
node msg

- Pointer to node.

- Pointer to message. - Source IP address. - Destination IP address.

sourceAddress

destinationAddress priority protocol ttl

- Currently a TosType. - IP protocol number.

- Time to live.If 0, uses default

Returns:
void

- None

FindAnIpOptionField

IpOptionsHeaderType* FindAnIpOptionField (const IpHeaderType* ipHeader, const int optionKey) Parameters:

Searches the IP header for the option field with option code that matches optionKey, and returns a pointer to the option field header.

ipHeader

- Pointer to an IP header. - Option code for desired option field.

optionKey

Returns:
IpOptionsHeaderType* - to the header of the desired option field. NULL if no option fields, or the desired option field cannot be found.

NetworkIpPreInit

void NetworkIpPreInit (Node* node) Parameters:

IP initialization required before any of the other layers are initialized. This is mainly for MAC initialization, which requires certain IP structures be pre-initialized.

node

- pointer to node.

Returns:
void

- None

NetworkIpInit

void NetworkIpInit (Node* node, const NodeInput* nodeInput) Parameters:

Called by transport layer protocols (UDP, TCP) to send UDP datagrams and TCP segments using IP. Simply calls NetworkIpSendRawMessage().

- Pointer to node.

- Pointer to message from transport - Source IP address. - Destination IP address.

sourceAddress

destinationAddress outgoingInterface priority protocol

- outgoing interface to use to

- Priority of packet. - IP protocol number. - Is this node ECN capable?

isEcnCapable

Returns:
void

- None

NetworkIpSendRawMessage

void NetworkIpSendRawMessage (Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl) Parameters:

Called by NetworkIpReceivePacketFromTransportLayer() to send

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

to send UDP datagrams, TCP segments using IP. Also called by network-layer routing protocols (AODV, OSPF, etc.) to send IP packets. This function adds an IP header and calls RoutePacketAndSendToMac().

node msg

- Pointer to node.

- Pointer to message with payload data - Source IP address. - Destination IP address.

sourceAddress

destinationAddress outgoingInterface priority protocol ttl

- outgoing interface to use to

- Priority of packet. - IP protocol number.

- Time to live.

Returns:
void

- None

NetworkIpSendRawMessageWithDelay

void NetworkIpSendRawMessageWithDelay (Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl, clocktype delay) Parameters:
node msg

Same as NetworkIpSendRawMessage(), but schedules event after a simulation delay.

- Pointer to node.

- Pointer to message with payload data - Source IP address. - Destination IP address.

sourceAddress

destinationAddress outgoingInterface priority protocol ttl

- outgoing interface to use to

- TOS of packet. - IP protocol number.

- Time to live. - Delay

delay

Returns:
void

- None

NetworkIpSendRawMessageToMacLayer

void NetworkIpSendRawMessageToMacLayer (Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl, int interfaceIndex, NodeAddress nextHop) Parameters:

Called by network-layer routing protocols (AODV, OSPF, etc.) to add an IP header to payload data, and with the resulting IP packet,
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

calls NetworkIpSendPacketOnInterface().

node msg

- Pointer to node.

- Pointer to message with payload data - Source IP address. - Destination IP address.

sourceAddress

destinationAddress priority protocol ttl

- TOS of packet. - IP protocol number.

- Time to live. - Index of outgoing interface.

interfaceIndex nextHop

- Next hop IP address.

Returns:
void

- None

NetworkIpSendRawMessageToMacLayerWithDelay

void NetworkIpSendRawMessageToMacLayerWithDelay (Node* node, Message* msg, NodeAddress sourceAddress, NodeAddress destinationAddress, TosType priority, unsigned char protocol, unsigned ttl, int interfaceIndex, NodeAddress nextHop, clocktype delay) Parameters:
node msg

Same as NetworkIpSendRawMessageToMacLayer(), but schedules the event after a simulation delay by calling NetworkIpSendPacketOnInterfaceWithDelay().

- Pointer to node.

- Pointer to message with payload data - Source IP address. - Destination IP address.

sourceAddress

destinationAddress priority protocol ttl

- TOS of packet. - IP protocol number.

- Time to live. - Index of outgoing interface.

interfaceIndex nextHop delay

- Next hop IP address.

- delay.

Returns:
void

- None

NetworkIpSendPacketToMacLayer

void NetworkIpSendPacketToMacLayer (Node* node, Message* msg, int interfaceIndex, NodeAddress nextHop)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Parameters: This function is called once the outgoing interface index and next hop address to which to route an IP packet are known.
node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of outgoing interface.

interfaceIndex nextHop

- Next hop IP address.

Returns:
void

- None

NetworkIpSendPacketOnInterface

void NetworkIpSendPacketOnInterface (Node* node, Message* msg, int incomingInterface, int outgoingInterface, NodeAddress nextHop) Parameters:

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of incoming interface. - Index of outgoing interface.

incomingInterface outgoingInterface nextHop

- Next hop IP address.

Returns:
void

- None

NetworkIpSendPacketToMacLayerWithDelay

void NetworkIpSendPacketToMacLayerWithDelay (Node* node, Message* msg, int interfaceIndex, NodeAddress nextHop, clocktype delay) Parameters:

Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay.

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of outgoing interface.

interfaceIndex nextHop delay

- Next hop IP address.

- delay

Returns:
void

- None

NetworkIpSendPacketOnInterfaceWithDelay

void NetworkIpSendPacketOnInterfaceWithDelay (Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop, clocktype delay)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Parameters: Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay.

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of incomming interface.

incommingInterface outgoingInterface nextHop delay

- Index of outgoing interface.

- Next hop IP address.

- delay

Returns:
void

- None

NetworkIpSendRawPacketOnInterfaceWithDelay

void NetworkIpSendRawPacketOnInterfaceWithDelay (Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop, clocktype delay) Parameters:

Same as NetworkIpSendPacketOnInterface(), but schedules event after a simulation delay and denotes raw packet.

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of incomming interface.

incommingInterface outgoingInterface nextHop delay

- Index of outgoing interface.

- Next hop IP address.

- delay

Returns:
void

- None

NetworkIpSendPacketToMacLayerWithNewStrictSourceRoute

void NetworkIpSendPacketToMacLayerWithNewStrictSourceRoute (Node* node, Message* msg, NodeAddress[] newRouteAddresses, int numNewRouteAddresses, BOOL removeExistingRecordedRoute) Parameters:

Tacks on a new source route to an existing IP packet and then sends the packet to the MAC layer.

node msg

- Pointer to node.

- Pointer to message with ip packet. - Source route (address array). - Number of array elements. - Flag to indicate previous record

newRouteAddresses

numNewRouteAddresses

removeExistingRecordedRoute

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

void

- None

NetworkIpReceivePacketFromMacLayer

void NetworkIpReceivePacketFromMacLayer (Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex) Parameters:

IP received IP packet from MAC layer. Updates the Stats database and then calls NetworkIpReceivePacket.

node msg

- Pointer to node.

- Pointer to message with ip packet. - nodeId of the previous hop.

previousHopNodeId interfaceIndex

- Index of interface on which packet arrived.

Returns:
void

- None

NetworkIpReceivePacket

void NetworkIpReceivePacket (Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex) Parameters:

node msg

- Pointer to node.

- Pointer to message with ip packet. - nodeId of the previous hop.

previousHopNodeId interfaceIndex

- Index of interface on which packet arrived.

Returns:
void

- None

NetworkIpNotificationOfPacketDrop

void NetworkIpNotificationOfPacketDrop (Node* node, Message* msg, NodeAddress nextHopNodeAddres, int interfaceIndex) Parameters:

Invoke callback functions when a packet is dropped.

node msg

- Pointer to node.

- Pointer to message with ip packet. - next hop address of dropped packet.

nextHopNodeAddres interfaceIndex

- interface that experienced the packet drop.

Returns:
void

- None

NetworkIpGetMacLayerStatusEventHandlerFunction
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

MacLayerStatusEventHandlerFunctionType NetworkIpGetMacLayerStatusEventHandlerFunction

(Node* node, int interfaceIndex) Parameters: Get the status event handler function pointer.
node

- Pointer to node. - interface associated with the status

interfaceIndex

Returns:
MacLayerStatusEventHandlerFunctionType

- Status event handler function.

NetworkIpSetMacLayerStatusEventHandlerFunction

void NetworkIpSetMacLayerStatusEventHandlerFunction (Node* node, MacLayerStatusEventHandlerFunctionType StatusEventHandlerPtr, int interfaceIndex) Parameters:

Allows the MAC layer to send status messages (e.g., packet drop, link failure) to a network-layer routing protocol for routing optimization.

node

- Pointer to node. - interface

StatusEventHandlerPtr interfaceIndex

- interface associated with the status

Returns:
void

- None

NetworkIpSneakPeekAtMacPacket

void NetworkIpSneakPeekAtMacPacket (Node* node, const Message* msg, int interfaceIndex, NodeAddress prevHop) Parameters:

node msg

- Pointer to node.

- The message being peeked at from the - The interface of which the "peeked" message belongs to.

interfaceIndex prevHop

- next hop address of dropped packet.

Returns:
void

- None

NetworkIpGetPromiscuousMessagePeekFunction

PromiscuousMessagePeekFunctionType NetworkIpGetPromiscuousMessagePeekFunction (Node* node, int interfaceIndex) Parameters:

Returns the network-layer function which will promiscuously inspect packets. See NetworkIpSneakPeekAtMacPacket().

node

- Pointer to node. - Interface associated with the peek function.

interfaceIndex

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

PromiscuousMessagePeekFunctionType

- Function pointer

NetworkIpSetPromiscuousMessagePeekFunction

void NetworkIpSetPromiscuousMessagePeekFunction (Node* node, PromiscuousMessagePeekFunctionType PeekFunctionPtr, int interfaceIndex) Parameters:

Sets the network-layer function which will promiscuously inspect packets. See NetworkIpSneakPeekAtMacPacket().

node

- Pointer to node. - Peek function.

PeekFunctionPtr interfaceIndex

- Interface associated with the peek function.

Returns:
void

- None

NetworkIpReceiveMacAck

void NetworkIpReceiveMacAck (Node* node, int interfaceIndex, const Message* msg, NodeAddress nextHop) Parameters:

MAC received an ACK, so call ACK handler function.

node

- Pointer to node. - Interface associated with the ACK handler function.

interfaceIndex msg

- Message that was ACKed. - Next hop that sent the MAC layer ACK

nextHop

Returns:
void

- None

NetworkIpGetMacLayerAckHandler

MacLayerAckHandlerType NetworkIpGetMacLayerAckHandler (Node* node, int interfaceIndex) Parameters:

Get MAC layer ACK handler

node

- Pointer to node. - Interface associated with ACK handler function

interfaceIndex

Returns:
MacLayerAckHandlerType

- MAC acknowledgement function pointer

NetworkIpSetMacLayerAckHandler

void NetworkIpSetMacLayerAckHandler (Node* node, MacLayerAckHandlerType macAckHandlerPtr, int interfaceIndex) Parameters:

Set MAC layer ACK handler

node

- Pointer to node. - Callback function handling

macAckHandlerPtr
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

interfaceIndex

- Interface associated with the ACK handler

Returns:
void

- None

SendToUdp

void SendToUdp (Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, int incomingInterfaceIndex) Parameters:

Sends a UDP packet to UDP in the transport layer. The source IP address, destination IP address, and priority of the packet are also sent.

node msg

- Pointer to node.

- Pointer to message with UDP packet. - TOS of UDP packet. - Source IP address. - Destination IP address. - interface that received the packet

priority

sourceAddress

destinationAddress

incomingInterfaceIndex

Returns:
void

- None

SendToTcp

void SendToTcp (Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, BOOL aCongestionExperienced) Parameters:

Sends a TCP packet to TCP in the transport layer. The source IP address, destination IP address, and priority of the packet are also sent..

node msg

- Pointer to node.

- Pointer to message with TCP packet. - TOS of TCP packet. - Source IP address. - Destination IP address. - Determine if congestion is

priority

sourceAddress

destinationAddress

aCongestionExperienced

Returns:
void

- None

SendToRsvp

void SendToRsvp (Node* node, Message* msg, TosType priority, NodeAddress sourceAddress, NodeAddress destinationAddress, int interfaceIndex, unsigned ttl) Parameters:

Sends a RSVP packet to RSVP in the transport layer. The source IP address, destination IP address, and priority of the packet are also sent.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

node

- Pointer to node.

msg

- Pointer to message with RSVP packet. - TOS of UDP packet. - Source IP address. - Destination IP address.

priority

sourceAddress

destinationAddress interfaceIndex ttl

- incoming interface index.

- Receiving TTL

Returns:
void

- None

NetworkIpRemoveIpHeader

void NetworkIpRemoveIpHeader (Node* node, Message* msg, NodeAddress* sourceAddress, NodeAddress* destinationAddress, TosType* priority, unsigned char* protocol, unsigned* ttl) Parameters:

Removes the IP header from a message while also returning all the fields of the header.

node msg

- Pointer to node.

- Pointer to message - Storage for source IP address. - Storage for destination IP

sourceAddress

destinationAddress priority protocol ttl

- Storage for TosType.(values are - Storage for IP protocol number

- Storage for time to live.

Returns:
void

- None

AddIpOptionField

void AddIpOptionField (Node* node, Message* msg, int optionCode, int optionSize) Parameters:

Inserts an option field in the header of an IP packet.

node msg

- Pointer to node.

- Pointer to message - The option code - Size of the option

optionCode optionSize

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

ExtractIpSourceAndRecordedRoute

void ExtractIpSourceAndRecordedRoute (Message* msg, NodeAddress[] RouteAddresses, int* NumAddresses, int* RouteAddressIndex) Parameters:

Retrieves a copy of the source and recorded route from the options field in the header.

msg

- Pointer to message with IP packet. - Storage for source/recorded route.

RouteAddresses NumAddresses

- Storage for size of RouteAddresses[] array. - The index of the first address of the

RouteAddressIndex

Returns:
void

- None

NetworkIpGetRouterFunction

RouterFunctionType NetworkIpGetRouterFunction (Node* node, int interfaceIndex) Parameters:

Get the router function pointer.

node

- Pointer to node. - interface associated with router function

interfaceIndex

Returns:
RouterFunctionType

- router function pointer.

NetworkIpSetRouterFunction

void NetworkIpSetRouterFunction (Node* node, RouterFunctionType RouterFunctionPtr, int interfaceIndex) Parameters:

node

- Pointer to node. - Router function to set.

RouterFunctionPtr interfaceIndex

- interface associated with router function.

Returns:
void

- None

void NetworkIpAddUnicastRoutingProtocolType (Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex) Parameters:

Add unicast routing protocol type to interface.

node

- Pointer to node.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

routingProtocolType interfaceIndex

- Router function to add.

- Interface associated with the router function.

Returns:
void

- None

NetworkIpAddUnicastIntraRegionRoutingProtocolType

void NetworkIpAddUnicastIntraRegionRoutingProtocolType (Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex) Parameters:

Add unicast intra region routing protocol type to interface.

node

- Pointer to node. - Router function to add.

routingProtocolType interfaceIndex

- Interface associated with the router function.

Returns:
void

- None

NetworkIpGetRoutingProtocol

void* NetworkIpGetRoutingProtocol (Node* node, NetworkRoutingProtocolType routingProtocolType) Parameters:

Get routing protocol structure associated with routing protocol running on this interface.

node

- Pointer to node. - network interface.

- pointer to ip queue.

Returns:
void

- None

NetworkIpSchedulerInit

void NetworkIpSchedulerInit (Node* node, const NodeInput* nodeInput, int interfaceIndex, Scheduler* schedulerPtr, const char* schedulerTypeString) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Call initialization function for appropriate scheduler.

node

- pointer to node - pointer to nodeinput - interface index

nodeInput

interfaceIndex schedulerPtr

- type of Scheduler - Scheduler name

schedulerTypeString

Returns:
void

- None

NetworkIpCpuQueueInsert

void NetworkIpCpuQueueInsert (Node* node, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull, int incomingInterface) Parameters:
node msg

- Pointer to node.

- Pointer to message with IP packet. - Packet's next hop address. - Packet's destination address.

nextHopAddress

destinationAddress outgoingInterface networkType queueIsFull

- Used to determine where packet

- Type of network packet is using (IP, - Storage for boolean indicator. - Incoming interface of packet.

incomingInterface

Returns:
void

- None

NetworkIpInputQueueInsert

void NetworkIpInputQueueInsert (Node* node, int incomingInterface, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull) Parameters:
node

- Pointer to node. - interface of input queue.

incomingInterface msg

- Pointer to message with IP packet. - Packet's next hop address.

nextHopAddress

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

destinationAddress outgoingInterface networkType queueIsFull

- Packet's destination address.

- Used to determine where packet

- Type of network packet is using (IP, - Storage for boolean indicator.

Returns:
void

- None

NetworkIpOutputQueueInsert

void NetworkIpOutputQueueInsert (Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull) Parameters:

node

- Pointer to node. - interface of input queue.

interfaceIndex msg

- Pointer to message with IP packet. - Packet's next hop address. - Packet's destination address.

nextHopAddress

destinationAddress networkType queueIsFull

- Type of network packet is using (IP, - Storage for boolean indicator.

Returns:
void

- None

NetworkIpInputQueueDequeuePacket

BOOL NetworkIpInputQueueDequeuePacket (Node* node, int incomingInterface, Message** msg, NodeAddress* nextHopAddress, int* outgoingInterface, int* networkType, QueuePriorityType* priority) Parameters:

Calls the packet scheduler for an interface to retrieve an IP packet from the input queue associated with the interface.

node

- Pointer to node. - interface to dequeue from.

incomingInterface msg

- Storage for pointer to message - Storage for Packet's - Used to determine where packet

nextHopAddress

outgoingInterface networkType priority

- Type of network packet is using (IP,

- Storage for

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

BOOL

- TRUE if dequeued successfully, FALSE otherwise.

NetworkIpOutputQueueDequeuePacket

BOOL NetworkIpOutputQueueDequeuePacket (Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, QueuePriorityType* priority) Parameters:

node

- Pointer to node. - index to interface .

interfaceIndex msg

- Storage for pointer to message - Storage for Packet's next hop address.

nextHopAddress networkType priority

- Type of network packet is using (IP,

- Storage for priority

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

NetworkIpOutputQueueDequeuePacketForAPriority

BOOL NetworkIpOutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, QueuePriorityType priority, Message** msg, NodeAddress* nextHopAddress, int* networkType, int posInQueue) Parameters:
node

- Pointer to node. - index to interface .

interfaceIndex priority msg

- priority of packet.

- Storage for pointer to message - Storage for Packet's next hop address.

nextHopAddress networkType posInQueue

- Type of network packet is using (IP,

- Position of packet in Queue.

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

NetworkIpOutputQueueDequeuePacketWithIndex

BOOL NetworkIpOutputQueueDequeuePacketWithIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType) Parameters:

node

- Pointer to node.

(mac/mac.pc), which itself is called from mac/mac_802_11.pc and other MAC protocol source files. This function will assert false if the scheduler cannot return an IP packet for whatever reason.

interfaceIndex msgIndex msg

- index to interface .

- index of packet.

- Storage for pointer to message - Storage for Packet's next hop address.

nextHopAddress networkType

- Type of network packet is using (IP,

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

NetworkIpInputQueueTopPacket

BOOL NetworkIpInputQueueTopPacket (Node* node, int incomingInterface, Message** msg, NodeAddress* nextHopAddress, int* outgoingInterface, int* networkType, QueuePriorityType* priority) Parameters:

node

- Pointer to node. - interface to get top packet from.

incomingInterface msg

- Storage for pointer to message - Storage for Packet's next hop addr. - Used to determine where packet should go

nextHopAddress

outgoingInterface networkType priority

- Type of network packet is using (IP,

- Storage for priority

Returns:
BOOL

- TRUE if there is a packet, FALSE otherwise.

NetworkIpOutputQueueTopPacket

BOOL NetworkIpOutputQueueTopPacket (Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, QueuePriorityType* priority) Parameters:

node

- Pointer to node. - index to interface .

interfaceIndex msg

- Storage for pointer to message - Storage for Packet's next hop addr.

nextHopAddress networkType priority

- Type of network of the packet

- Storage for priority

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

BOOL

- TRUE if there is a packet, FALSE otherwise.

NetworkIpOutputQueuePeekWithIndex

BOOL NetworkIpOutputQueuePeekWithIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress* nextHopAddress, QueuePriorityType* priority) Parameters:

node

- Pointer to node. - index to interface .

interfaceIndex msgIndex msg

- index to message .

- Storage for pointer to message - Storage for Packet's next hop addr.

nextHopAddress priority

- Storage for priority

Returns:
BOOL

- TRUE if there is a packet, FALSE otherwise.

NetworkIpOutputQueueTopPacketForAPriority

BOOL NetworkIpOutputQueueTopPacketForAPriority (Node* node, int interfaceIndex, QueuePriorityType priority, Message** msg, NodeAddress* nextHopAddress, int posInQueue) Parameters:

node

- Pointer to node. - index to interface .

interfaceIndex priority msg

- priority of packet

- Storage for pointer to message - Storage for packet's next hop address.

nextHopAddress posInQueue

- Position of packet in Queue.

Returns:
BOOL

- TRUE if there is a packet, FALSE otherwise.

NetworkIpInputQueueIsEmpty

BOOL NetworkIpInputQueueIsEmpty (Node* node, int incomingInterface) Parameters:

Calls the packet scheduler for an interface to determine whether the interface's input queue is empty

node

- Pointer to node. - Index of interface.

incomingInterface

Returns:
BOOL
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

- TRUE if the scheduler says the interface's input queue is empty. FALSE if the scheduler says the interface's input queue is not empty. NetworkIpOutputQueueIsEmpty BOOL NetworkIpOutputQueueIsEmpty (Node* node, int interfaceIndex) Parameters: Calls the packet scheduler for an interface to determine whether the interface's output queue is empty.
node

- Pointer to node. - Index of interface.

interfaceIndex

Returns:
BOOL

- TRUE if the scheduler says the interface's output queue is empty. FALSE if the scheduler says the interface's output queue is not empty.

NetworkIpOutputQueueNumberInQueue

int NetworkIpOutputQueueNumberInQueue (Node* node, int interfaceIndex, BOOL specificPriorityOnly, QueuePriorityType priority) Parameters:

Calls the packet scheduler for an interface to determine how many packets are in a queue. There may be multiple queues on an interface, so the priority of the desired queue is also provided.

node

- Pointer to node. - Index of interface. - Should we only get the number of packets

interfaceIndex

specificPriorityOnly priority

- Priority of queue.

Returns:
int

- Number of packets in queue.

NetworkIpOutputQueueDropPacket

NodeAddress NetworkIpOutputQueueDropPacket (Node* node, int interfaceIndex, Message** msg) Parameters:

Drop a packet from the queue.

node

- Pointer to node. - index to interface .

interfaceIndex msg

- Storage for pointer to message

Returns:
NodeAddress

- Next hop of dropped packet.

NetworkIpDeleteOutboundPacketsToANode

void NetworkIpDeleteOutboundPacketsToANode (Node* node, const NodeAddress nextHopAddress, const NodeAddress destinationAddress, const BOOL returnPacketsToRoutingProtocol) Parameters:

Deletes all packets in the queue going (probably broken), to the specified next hop address. There is option to return all such packets back to the routing protocols. via the usual mechanism
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

node

- Pointer to node. - Next hop associated with

nextHopAddress

(callback).
destinationAddress

- destination associated with - Determine whether or not

returnPacketsToRoutingProtocol

Returns:
void

- None

GetQueueNumberFromPriority

unsigned GetQueueNumberFromPriority (TosType userTos, int numQueues) Parameters:

Get queue number through which a given user priority will be forwarded.

userTos

- user TOS. - Number of queues.

numQueues

Returns:
unsigned

- Index of the queue.

ReturnPriorityForPHB

QueuePriorityType ReturnPriorityForPHB (Node* node, TosType tos) Parameters:

Returns the priority queue corresponding to the DS/TOS field.

node tos

- Pointer to node.

- TOS field

Returns:
QueuePriorityType

- priority queue

NetworkGetInterfaceAndNextHopFromForwardingTable

void NetworkGetInterfaceAndNextHopFromForwardingTable (Node* node, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress) Parameters:

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).

node

- Pointer to node. - Destination IP address.

destinationAddress interfaceIndex nextHopAddress

- Storage for index of outgoing - Storage for next hop IP address.

Returns:
void

- None

NetworkGetInterfaceAndNextHopFromForwardingTable

void NetworkGetInterfaceAndNextHopFromForwardingTable (Node* node, int currentInterface, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).

node

- Pointer to node. - Current interface in use. - Destination IP address.

currentInterface

destinationAddress interfaceIndex nextHopAddress

- Storage for index of outgoing - Storage for next hop IP address.

Returns:
void

- None

NetworkGetInterfaceAndNextHopFromForwardingTable

void NetworkGetInterfaceAndNextHopFromForwardingTable (Node* node, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress, BOOL testType, NetworkRoutingProtocolType type) Parameters:
node

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).

- Pointer to node. - Destination IP address.

destinationAddress interfaceIndex nextHopAddress testType type

- Storage for index of outgoing - Storage for next hop IP address.

- Same protocol's routes if true

- routing protocol type.

Returns:
void

- None

NetworkGetInterfaceAndNextHopFromForwardingTable

void NetworkGetInterfaceAndNextHopFromForwardingTable (Node* node, int operatingInterface, NodeAddress destinationAddress, int* interfaceIndex, NodeAddress* nextHopAddress, BOOL testType, NetworkRoutingProtocolType type) Parameters:
node

Do a lookup on the routing table with a destination IP address to obtain a route (index of an outgoing interface and a next hop Ip address).

- Pointer to node. - interface currently being - Destination IP address.

operatingInterface destinationAddress interfaceIndex nextHopAddress testType

- Storage for index of outgoing - Storage for next hop IP address.

- Same protocol's routes if true

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

type

- routing protocol type.

Returns:
void

- None

NetworkIpGetInterfaceIndexForNextHop

int NetworkIpGetInterfaceIndexForNextHop (Node* node, NodeAddress nextHopAddress) Parameters:

node

- Pointer to node. - Destination IP address.

nextHopAddress

Returns:
int

- Index of outgoing interface, if nextHopAddress is on a directly connected network. -1, otherwise

NetworkGetInterfaceIndexForDestAddress

int NetworkGetInterfaceIndexForDestAddress (Node* node, NodeAddress destAddress) Parameters:

Get interface for the destination address.

node

- Pointer to node. - Destination IP address.

destAddress

Returns:
int

- interface index associated with destination.

NetworkRoutingGetAdminDistance

NetworkRoutingAdminDistanceType NetworkRoutingGetAdminDistance (Node* node, NetworkRoutingProtocolType type) Parameters:

Get the administrative distance of a routing protocol. These values don't quite match those recommended by Cisco.

node type

- Pointer to node. - Type value of routing protocol.

Returns:
NetworkRoutingAdminDistanceType

- The administrative distance of the routing protocol.

NetworkInitForwardingTable

void NetworkInitForwardingTable (Node* node) Parameters:

Initialize the IP fowarding table, allocate enough memory for number of rows.

node

- Pointer to node.

Returns:
void

- None

NetworkUpdateForwardingTable
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

void NetworkUpdateForwardingTable (Node* node, NodeAddress destAddress,

NodeAddress destAddressMask, NodeAddress nextHopAddress, int outgoingInterfaceIndex, int cost, NetworkRoutingProtocolType type) Update or add entry to IP routing table. Search the routing table for an entry with an exact match for destAddress, destAddressMask, and routing protocol. Update this entry with the specified nextHopAddress (the outgoing interface is automatically determined from the nextHopAddress -- see code). If no matching entry found, then add a new route. Parameters:
node

- Pointer to node. - IP address of destination - Netmask.

destAddress

destAddressMask nextHopAddress

- Next hop IP address. - outgoing interface.

outgoingInterfaceIndex cost type

- Cost metric associated with - type value of

Returns:
void

- None

NetworkRemoveForwardingTableEntry

void NetworkRemoveForwardingTableEntry (Node* node, NodeAddress destAddress, NodeAddress destAddressMask, NodeAddress nextHopAddress, int outgoingInterfaceIndex) Parameters:

Remove single entries in the routing table

node

- Pointer to node. - IP address of destination - Netmask.

destAddress

destAddressMask nextHopAddress

- Next hop IP address. - outgoing interface.

- Pointer to node. - destination to get cost metric from.

destAddress

Returns:
int

- Cost metric associated with destination.

NetworkIpSetRouteUpdateEventFunction

void NetworkIpSetRouteUpdateEventFunction (Node* node, NetworkRouteUpdateEventType routeUpdateFunctionPtr) Parameters:

Set a callback fuction when a route changes from forwarding table.

node

- Pointer to node. - Route update

routeUpdateFunctionPtr

Returns:
void

- None

NetworkIpGetRouteUpdateEventFunction

NetworkRouteUpdateEventType NetworkIpGetRouteUpdateEventFunction (Node* node) Parameters:

Print packet headers when packet tracing is enabled.

node

- Pointer to the node

interfaceIndex

- Number of interface

Returns:
NodeAddress

- Broadcast address of specified interface

IsOutgoingBroadcast

BOOL IsOutgoingBroadcast (Node* node, NodeAddress destAddress, int* outgoingInterface, NodeAddress* outgoingBroadcastAddress) Parameters:

Checks whether IP packet's destination address is broadcast

node

- Pointer to the node - IP packet's destination IP address. - Outgoing interface index. - Broadcast address

destAddress

outgoingInterface

outgoingBroadcastAddress

Returns:
BOOL

- Returns true if destination is broadcast address

NetworkIpIsMyIP

BOOL NetworkIpIsMyIP (Node* node, NodeAddress ipAddress) Parameters:

In turn calls IsMyPacket()

node

- Pointer to the node - An IP packet's destination IP address.

ipAddress

Returns:
BOOL

- Returns if it belongs to it.

NetworkIpConfigurationError

void NetworkIpConfigurationError (Node* node, char [] parameterName, int interfaceIndex) Parameters:

Prints out the IP configuration error

node

- Pointer to the node - Error message to print - interface number

- Pointer to the node

Returns:
void

- None

NetworkIpIsPartOfMulticastGroup

BOOL NetworkIpIsPartOfMulticastGroup (Node* node, NodeAddress groupAddress) Parameters:

check if a node is part of specified multicast group

node

- Pointer to the node - group to check if node is part of

groupAddress

Returns:
BOOL

- None

NetworkIpJoinMulticastGroup

void NetworkIpJoinMulticastGroup (Node* node, NodeAddress mcastAddr, clocktype delay) Parameters:

To join a multicast group

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

node

- Pointer to the node

mcastAddr delay

mcastAddr delay

Returns:
MulticastRouterFunctionType

- Multicast router function on this interface.

NetworkIpUpdateMulticastRoutingProtocolAndRouterFunction

void NetworkIpUpdateMulticastRoutingProtocolAndRouterFunction (Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex) Parameters:

node

- this node - multicast routing

routingProtocolType interfaceIndex

- interface index.

Returns:
void

- None

NetworkIpUpdateUnicastRoutingProtocolAndRouterFunction

void NetworkIpUpdateUnicastRoutingProtocolAndRouterFunction (Node* node, NetworkRoutingProtocolType routingProtocolType, int interfaceIndex) Parameters:

node

- this node - unicast routing

routingProtocolType interfaceIndex

- interface associated with unicast protocol.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

void

- None

NetworkIpGetInterfaceIndexFromAddress

int NetworkIpGetInterfaceIndexFromAddress (Node* node, NodeAddress address) Parameters:

Get the interface index from an IP address.

node

- this node - address to determine interface index for

address

Returns:
int

- interface index associated with specified address.

NetworkIpGetInterfaceIndexFromSubnetAddress

int NetworkIpGetInterfaceIndexFromSubnetAddress (Node* node, NodeAddress address) Parameters:

Get the interface index from an IP subnet address.

node

- this node - subnet address to determine interface

address

Returns:
int

- interface index associated with specified subnet address.

NetworkIpIsMulticastAddress

BOOL NetworkIpIsMulticastAddress (Node* node, NodeAddress address) Parameters:

Check if an address is a multicast address.

node

- this node - address to determine if multicast address.

- its own node - multicast source address

sourceAddress groupAddress

- multicast group

Returns:
LinkedList*

- interface Id from node to (source, multicast group), or NETWORK_UNREACHABLE (no such entry is found)

NetworkUpdateMulticastForwardingTable

void NetworkUpdateMulticastForwardingTable (Node* node, NodeAddress sourceAddress, NodeAddress multicastGroupAddress, int interfaceIndex) Parameters:

update entry with(sourceAddress,multicastGroupAddress) pair. search for the row with(sourceAddress,multicastGroupAddress) and update its interface.

node

- its own node - multicast source - multicast group

sourceAddress

multicastGroupAddress interfaceIndex

- interface to use for

Returns:
void

- None

NetworkPrintMulticastForwardingTable

void NetworkPrintMulticastForwardingTable (Node* node) Parameters:

display all entries in multicast forwarding table of the node.

node

- this node

Returns:
void

- None

NetworkPrintMulticastOutgoingInterface

void NetworkPrintMulticastOutgoingInterface (Node* node, list* list) Parameters:

Print mulitcast outgoing interfaces.

node list

- this node - list of outgoing interfaces.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

Returns:
void

- None

NetworkInMulticastOutgoingInterface

BOOL NetworkInMulticastOutgoingInterface (Node* node, List* list, int interfaceIndex) Parameters:

Determine if interface is in multicast outgoing interface list.

node list

- this node - list of outgoing interfaces. - interface to determine if in outgoing

interfaceIndex

Returns:
BOOL

- TRUE if interface is in multicast outgoing interface list, FALSE otherwise.

NetworkIpPrintTraceXML

void NetworkIpPrintTraceXML (Node* node, Message* msg) Parameters:

Print packet trace information in XML format.

node msg

- this node

- Packet to print headers from.

Returns:
void

- None

RouteThePacketUsingLookupTable

void RouteThePacketUsingLookupTable (Node* node, Message* msg, int incomingInterface) Parameters:

Tries to route and send the packet using the node's forwarding table.

node msg

- this node

- Pointer to message with IP packet. - incoming interface of packet

incomingInterface

Returns:
void

- NULL

GetNetworkIPFragUnit

int GetNetworkIPFragUnit (Node* node, int interfaceIndex) Parameters:

Returns the network ip fragmentation unit.

node

- this node - interface of node

interfaceIndex

Returns:
int
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

- None

NetworkIpUserProtocolInit

void NetworkIpUserProtocolInit (Node* node, const NodeInput* nodeInput, const char* routingProtocolString, NetworkRoutingProtocolType* routingProtocolType, void** routingProtocolData) Parameters:
node

Initialization of user protocol(disabled)

- this node - Provides access to - routing protocol

nodeInput

routingProtocolString routingProtocolType routingProtocolData

- routing protocol - Access to routing protocol data

Returns:
void

- None

NetworkIpUserHandleProtocolEvent

void NetworkIpUserHandleProtocolEvent (Node* node, Message* msg) Parameters:

Event handler function of user protocol(disabled)

node msg

- The node that is handling the event.

- the event that is being handled

Returns:
void

- None

NetworkIpUserHandleProtocolPacket

void NetworkIpUserHandleProtocolPacket (Node* node, Message* msg, unsigned char ipProtocol, NodeAddress sourceAddress, NodeAddress destinationAddress, int ttl) Parameters:

Process a user protocol generated control packet(disabled)

node msg

- this node

- message that is being received. - ip protocol - source address - destination address

ipProtocol

sourceAddress

destinationAddress ttl

- time to live

Returns:
void

- None

NetworkIpUserProtocolFinalize
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

void NetworkIpUserProtocolFinalize (Node* node, int userProtocolNumber)

Parameters: Finalization of user protocol(disabled)

node

- this node - protocol number

userProtocolNumber

Returns:
void

- None

Atm_RouteThePacketUsingLookupTable

void Atm_RouteThePacketUsingLookupTable (Node* node, NodeAddress* destAddr, int* outIntf, NodeAddress* nextHop) Parameters:

Routing packet received at ATM node

node

- this node - destination Address

destAddr outIntf nextHop

- this node - nextHop address

Returns:
void

- None

RouteThePacketUsingMulticastForwardingTable

void RouteThePacketUsingMulticastForwardingTable (Node* node, Message* msg, int incomingInterface) Parameters:

Tries to route the multicast packet using the multicast forwarding table.

node msg

- this node

- Pointer to Message - Incomming Interface

incomingInterface

Returns:
void

- NULL.

NETWORKIpRoutingInit

int NETWORKIpRoutingInit (Node * node, const NodeInput *nodeInput nodeInput) Parameters:

Initialization function for network layer. Initializes IP.

node

- Pointer to node. - Pointer to node input.

nodeInput

interfaceIndex

Returns:
BOOL

- None

NetworkIpIsPointToPointNetwork

BOOL NetworkIpIsPointToPointNetwork (Node* node, int interfaceIndex) Parameters:

Determines if an interface is a point-to-point.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

node

- node structure pointer.

- Pointer to the node. - Source node id.

sourceNodeId destNodeId

- Destination node id.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

NetworkType

- None

NetworkIpIsWiredBroadcastNetwork

BOOL NetworkIpIsWiredBroadcastNetwork (Node* node, int interfaceIndex) Parameters:

Determines if an interface is a wired interface.

node

- node structure pointer. - interface Index.

interfaceIndex

Returns:
BOOL

- None

FindTraceRouteOption

ip_traceroute* FindTraceRouteOption (const IpHeaderType* ipHeader) Parameters:

Searches the IP header for the Traceroute option field , and returns a pointer to traceroute header.

ipHeader

- Pointer to an IP header.

Returns:
ip_traceroute*

- pointer to the header of the traceroute option field. NULL if no option fields, or the desired option field cannot be found.

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IP.html[5/24/2011 12:34:46 PM]

IPv6

EXata 2.2 API Specification

IPv6
Data structures and parameters used in network layer are defined here. Constant / Data Structure Summary Type
CONSTANT

Name
MAX_KEY_LEN

Maximum Key length of ipv6 address.

CONSTANT MAX_PREFIX_LEN

Maximum Prefix length of ipv6 address.

CONSTANT CURR_HOP_LIMIT

Current Hop limit a packet will traverse.

CONSTANT IPV6_ADDR_LEN

Ipv6 Address Lenght.

CONSTANT IP6_NHDR_HOP

Hop-by_hop IPv6 Next header field value.

CONSTANT IP6_NHDR_RT

Routing IPv6 Next header field value.

CONSTANT IP6_NHDR_FRAG

Fragment IPv6 Next header field value.

CONSTANT IP6_NHDR_AUTH

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Authentication IPv6 Next header field value.

CONSTANT IP6_NHDR_ESP

Encryption IPv6 Next header field value.

CONSTANT IP6_NHDR_IPCP

Compression IPv6 Next header field value.

CONSTANT IP6_NHDR_OSPF

Compression IPv6 Next header field value.

CONSTANT IP6_NHDR_DOPT

Destination IPv6 Next header field value.

CONSTANT IP6_NHDR_NONH

No next header IPv6 Next header field value.

CONSTANT IPV6_FLOWINFO_VERSION

Flow infromation version.

CONSTANT IPV6_VERSION

IPv6 version no.

CONSTANT IP6_MMTU

Minimal MTU and reassembly.

CONSTANT IPPROTO_ICMPV6

ICMPv6 protocol no.

CONSTANT IP6ANY_ANYCAST

IPv6 anycast.
CONSTANT ND_DEFAULT_HOPLIM

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Node Discovery hop count.

CONSTANT IP6_INSOPT_NOALLOC

IPv6 insert option with no allocation.

CONSTANT IP6_INSOPT_RAW

IPv6 insert raw option.

CONSTANT IP_FORWARDING

IPv6 forwarding flag.

CONSTANT IP6F_RESERVED_MASK

Reserved fragment flag.

CONSTANT IP_DF

Don't fragment flag.

CONSTANT IP6F_MORE_FRAG

More fragments flag.

CONSTANT IP6F_OFF_MASK

Mask for fragmenting bits.

CONSTANT IP6_FRAGTTL

Time to live for frags.

CONSTANT IP6_T_FLAG

T Flag if set indicates transient multicast address.

CONSTANT Multicast Address Scope Related constants.

CONSTANT

IP_FRAGMENT_HOLD_TIME

IP Fragment hold time.

CONSTANT IP_ROUTETOIF

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

IPv6 route to interface.

CONSTANT IP_DEFAULT_MULTICAST_TTL

IPv6 route to interface.

CONSTANT IPTTLDEC

TTL decrement.
CONSTANT ENETUNREACH

Network unreachable.
CONSTANT EHOSTUNREACH

Host unreachable.
CONSTANT MAX_INITIAL_RTR_ADVERT_INTERVAL

Router Advertisement timer.

CONSTANT RTR_SOLICITATION_INTERVAL

Router Solicitation timer.

CONSTANT REACHABLE_TIME

reachable time
CONSTANT UNREACHABLE_TIME

unreachable time
CONSTANT RETRANS_TIMER

retransmission timer
CONSTANT MAX_NEIGHBOR_ADVERTISEMENT

maximum neighbor advertisement

CONSTANT MAX_RTR_SOLICITATIONS

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

maximum Router Solicitations NOTE : Sending only one Solicitation; modify it once autoconfiguration supported.
CONSTANT MAX_MULTICAST_SOLICIT

maximum multicast solicitation

CONSTANT MAX_UNICAST_SOLICIT

maximum unicast solicitation

CONSTANT PKT_EXPIRE_DURATION

Packet expiration interval

CONSTANT INVALID_LINK_ADDR

Invalid Link Layer Address

CONSTANT MAX_HASHTABLE_SIZE

Maximum size of Hash-Table

CONSTANT MAX_REVLOOKUP_SIZE

Maximum Rev Look up hash table size

CONSTANT IP6_LSRRT

type 0
CONSTANT IP6_NIMRT

type 1
CONSTANT IP6_RT_MAX

Maximum number of addresses.

CONSTANT IP6ANY_HOST_PROXY

proxy (host)
CONSTANT IP6ANY_ROUTER_PROXY

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

proxy (router)
STRUCT ip6_hdr_struct

QualNet typedefs struct ip6_hdr_struct to ip6_hdr. struct ip6_hdr_struct is 40 bytes, just like in the BSD code.
STRUCT in6_multi_struct

QualNet typedefs struct in6_multi_struct to in6_multi. struct in6_multi_struct is just like in the BSD code.
STRUCT ipv6_h2hhdr_struct

QualNet typedefs struct ipv6_h2hhdr_struct to ipv6_h2hhdr. struct ipv6_h2hhdr_struct is hop-by-Hop Options Header of 14 bytes, just like in the BSD code.
STRUCT ipv6_rthdr_struct

QualNet typedefs struct ipv6_rthdr_struct to ipv6_rthdr. struct ipv6_h2hhdr_struct is routing options header of 8 bytes, just like in the BSD code.
STRUCT ipv6_rthdr_struct

QualNet typedefs struct ipv6_rthdr_struct to ipv6_rthdr. struct ipv6_h2hhdr_struct is destination options header of 8 bytes, just like in the BSD code.
STRUCT ip_moptions_struct

QualNet typedefs struct ip_moptions_struct to ip_moptions. struct ip_moptions_struct is multicast option structure, just like in the BSD code.
STRUCT ip6_frag_struct

QualNet typedefs struct ip6_frag_struct to ipv6_fraghdr. struct ip6_frag_struct is fragmentation header structure.
STRUCT ip6Stat_struct

QualNet typedefs struct ip6stat_struct to ip6Stat. struct ip6stat_struct is statistic information structure.
STRUCT Ipv6MulticastForwardingTableRow

Structure of an entity of multicast forwarding table.

STRUCT Ipv6MulticastForwardingTable

Structure of multicast forwarding table

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

STRUCT

Ipv6MulticastGroupEntry

Structure for Multicast Group Entry

STRUCT IPv6InterfaceInfo

QualNet typedefs struct ipv6_interface_struct to IPv6InterfaceInfo. struct ipv6_interface_struct is interface information structure.
STRUCT messageBuffer

QualNet typedefs struct messageBufferStruct to messageBuffer. struct messageBufferStruct is the buffer to hold messages when neighbour discovery is not done.
STRUCT ip6q

QualNet typedefs struct ip6q_struct to ip6q. struct ip6q is a simple queue to hold fragmented packets.
STRUCT Ipv6FragQueue

Ipv6 fragment queue structure.

STRUCT FragmetedMsg

QualNet typedefs struct fragmeted_msg_struct to ip6q. struct fragmeted_msg_struct is a simple fragmented packets msg hold structure.
STRUCT defaultRouterList

default router list structure.

STRUCT destination_route_struct

QualNet typedefs struct destination_route_struct to destinationRoute. struct destination_route_struct is destination information structure of a node.
STRUCT DestinationCache

Destination cache entry structure

STRUCT Ipv6HashData

Ipv6 hash data structure.

STRUCT Ipv6HashBlockData

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Ipv6 hash block-data structure.

STRUCT Ipv6HashBlock

Ipv6 hash block structure.

STRUCT Ipv6HashTable

Ipv6 hash table structure

STRUCT IPv6Data

QualNet typedefs struct ipv6_data_struct to IPv6Data. struct ipv6_data_struct is ipv6 information structure of a node.
STRUCT ndpNadvEvent

QualNet typedefs struct ndp_event_struct to IPv6Data. struct ndp_event_struct is neighbor advertisement information structure.

Function / Macro Summary Return Type

MACRO

Summary
ND_DEFAULT_CLASS(0xe0)

Node Discovery sets class.

MACRO NDP_DELAY

NDP neighbor advertisement delay.

MACRO IPV6JITTER_RANGE

IPv6 jitter timer.

MACRO IPV6_SET_CLASS(hdr, priority)

Sets the flow class.

MACRO IPV6_GET_CLASS(hdr)

Gets the flow class.

void ip6_hdrSetVersion()(UInt32 ipv6HdrVcf, UInt32 version)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Set the value of version for ip6_hdr

void ip6_hdrSetClass()(UInt32 ipv6HdrVcf, unsigned char ipv6Class)

Set the value of class for ip6_hdr

void ip6_hdrSetFlow()(UInt32 ipv6HdrVcf, UInt32 flow)

Set the value of flow for ip6_hdr

UInt32 ip6_hdrGetVersion()(unsigned int ipv6HdrVcf)

Returns the value of version for ip6_hdr

UInt32 ip6_hdrGetClass()(unsigned int ipv6HdrVcf)

Returns the value of ip6_class for ip6_hdr

UInt32 ip6_hdrGetFlow()(unsigned int ipv6HdrVcf)

Returns the value of ip6_flow for ip6_hdr

int in6_isanycast(Node* node, in6_addr addr)

Checks whether the address is anycast address of the node.

None Ipv6AddIpv6Header(Node* node, Message* msg, in6_addr srcaddr, in6_addr dst_addr, TosType priority, unsigned char protocol, unsigned hlim)

Add an IPv6 packet header to a message. Just calls AddIpHeader.

None Ipv6AddFragmentHeader(Node *node node, Message *msg msg, unsigned char nextHeader, unsigned short offset, unsigned int id)

Adds fragment header

None Ipv6RemoveIpv6Header(Node *node node, Message *msg msg, Address* sourceAddress, Address* destinationAddress destinationAddress, TosType *priority priority, unsigned char *protocol protocol, unsigned *hLim hLim)

Removes Ipv6 header

None Ipv6PreInit(Node* node)

IPv6 Pre Initialization.

None IPv6Init(Node* node, const NodeInput* nodeInput)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

IPv6 Initialization.
BOOL Ipv6IsMyPacket(Node* node, in6_addr* dst_addr)

Checks whether the packet is the nodes packet. if the packet is of the node then returns TRUE, otherwise FALSE.
BOOL Ipv6IsAddressInNetwork(const in6_addr* globalAddr, unsigned int tla, unsigned int vla, unsigned int sla)

Checks whether the address is in the same network. : if in the same network then returns TRUE, otherwise FALSE.
NodeAddress Ipv6GetLinkLayerAddress(Node* node, int interfaceId, char* ll_addr_str)

Returns 32 bit link layer address of the interface.

None Ipv6AddNewInterface(Node* node, in6_addr* globalAddr, unsigned int tla, unsigned int nla, unsigned int sla, int* newinterfaceIndex, const NodeInput* nodeInput)

Adds an ipv6 interface to the node.

BOOL Ipv6IsForwardingEnabled(IPv6Data* ipv6)

Checks whether the node is forwarding enabled.

None Ipv6Layer(Node* node, Message* msg)

Handle IPv6 layer events, incoming messages and messages sent to itself (timers, etc.).
None Ipv6Finalize(Node* node)

Finalize function for the IPv6 model. Finalize functions for all network-layer IPv6 protocols are called here.
int Ipv6GetMTU(Node* node, int interfaceId)

Returns the maximum transmission unit of the interface.

int Ipv6GetInterfaceIndexFromAddress(Node* node, in6_addr* dst)

Returns interface index of the specified address.

None Ipv6CpuQueueInsert(Node* node, Message* msg, NodeAddress nextHopAddress, in6_addr destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull)

Calls the cpu packet scheduler for an interface to retrieve an IPv6 packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IPv6 address. The packet's priority value is also returned.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

None

Ipv6InputQueueInsert(Node* node, int incomingInterface, Message* msg, NodeAddress nextHopAddress, in6_addr destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull)

Calls input packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IPv6 address. The packet's priority value is also returned.
None Ipv6OutputQueueInsert(Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull)

Calls output packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IPv6 address. The packet's priority value is also returned. Called by QueueUpIpFragmentForMacLayer().
None QueueUpIpv6FragmentForMacLayer(Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull)

Calls output packet scheduler for an interface to retrieve an IP packet from a queue associated with the interface. The dequeued packet, since it's already been routed, has an associated next-hop IPv6 address. The packet's priority value is also returned. Called by QueueUpIpFragmentForMacLayer().
None Ipv6SendPacketOnInterface(Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop)

This function is called once the outgoing interface index and next hop address to which to route an IPv6 packet are known. This queues an IPv6 packet for delivery to the MAC layer. This functions calls QueueUpIpFragmentForMacLayer(). This function is used to initiate fragmentation if required,before calling the next function.
None Ipv6SendOnBackplane(Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress hopAddr)

This function is called when the packet delivered through backplane delay. required,before calling the next function.
None Ipv6SendRawMessage(Node* node, Message* msg, in6_addr sourceAddress, in6_addr destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl)

Called by NetworkIpReceivePacketFromTransportLayer() to send to send UDP datagrams using IPv6. This function adds an IPv6 header and calls RoutePacketAndSendToMac().
None Ipv6SendToUdp(Node* node, Message* msg, TosType priority, Address sourceAddress, Address destinationAddress, int incomingInterfaceIndex)

Sends a UDP packet to UDP in the transport layer. The source IPv6 address, destination IPv6 address, and priority of the packet are also sent.
None Ipv6SendToTCP(Node* node, Message* msg, TosType priority, Address sourceAddress, Address destinationAddress, int incomingInterfaceIndex)

Sends a TCP packet to UDP in the transport layer. The source IPv6 address, destination IPv6 address, and priority of the packet are also sent.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

None

Ipv6ReceivePacketFromMacLayer(Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex)

IPv6 received IPv6 packet from MAC layer. Determine whether the packet is to be delivered to this node, or needs to be forwarded.
BOOL Ipv6AddMessageInBuffer(Node* node, Message* msg, in6_addr* nextHopAddr, int inCommingInterface)

Adds an ipv6 packet in message in the hold buffer

BOOL Ipv6DeleteMessageInBuffer(Node* node, messageBuffer* mBuf)

Delets an ipv6 packet in the hold buffer

void Ipv6DropMessageFromBuffer(Node* node, messageBuffer* mBuf)

Drops an ipv6 packet from the hold buffer

NetworkType Ipv6GetAddressTypeFromString(char* interfaceAddr)

Returns network type from string ip address.

IPv6 multicast address Ipv6GetInterfaceMulticastAddress(Node* node, int interfaceIndex)

Get multicast address of this interface

None Ipv6SolicitationMulticastAddress(in6_addr* dst_addr, in6_addr* target)

Copies multicast solicitation address.

None Ipv6AllRoutersMulticastAddress(in6_addr* dst dst)

Function to assign all routers multicast address.

None IPv6GetLinkLocalAddress( node, int interface, in6_addr* addr)

Gets ipv6 link local address of the interface in output parameter addr.
None IPv6GetSiteLocalAddress( node, int interface, in6_addr* addr)

Gets ipv6 site local address of the interface in output parameter addr.
None IPv6GetSiteLocalAddress( node, int interface, in6_addr* addr)

Gets ipv6 global agreeable address of the interface in output parameter addr.
None Ipv6GetPrefix(in6_addr* addr, in6_addr* prefix)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Gets ipv6 prefix from address.

Prefix for this interface Ipv6GetPrefixFromInterfaceIndex(Node* node, int interfaceIndex)

Gets ipv6 prefix from address.

BOOL Ipv6OutputQueueIsEmpty(Node *node node, int interfaceIndex)

Check weather output queue is empty

None Ipv6RoutingStaticInit(Node *node node, const NodeInput nodeInput, NetworkRoutingProtocolType type)

Ipv6 Static routing initialization function.

None Ipv6RoutingStaticEntry(Node *node node, char currentLine[] currentLine)

Static routing route entry function

None Ipv6AddDestination(Node* node node, route* ro ro)

Adds destination in the destination cache.

None Ipv6DeleteDestination(Node* node node)

Deletes destination from the destination cache.

int Ipv6CheckForValidPacket(Node* node node, SchedulerType* scheduler scheduler, unsigned int* pIndex pIndex)

Checks the packet's validity

None Ipv6NdpProcessing(Node* node node)

Ipv6 Destination cache and neighbor cache : processing function

None Ipv6UpdateForwardingTable(Node* node node, in6_addr destPrefix destPrefix, in6_addr nextHopPrefix nextHopPrefix, int interfaceIndex, int metric metric)

Updates Ipv6 Forwarding Table

None Ipv6EmptyForwardingTable(Node* node node, NetworkRoutingProtocolType type type)

Empties Ipv6 Forwarding Table for a particular routing protocol entry

None Ipv6PrintForwardingTable(Node* node node)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Prints the forwarding table.

Interface index associated with specified subnet address. Ipv6InterfaceIndexFromSubnetAddress(Node* node node, in6_addr* address)

Get the interface index from an IPv6 subnet address.

void Ipv6GetInterfaceAndNextHopFromForwardingTable(Node* node node, in6_addr destAddr, int* interfaceIndex, in6_addr* nextHopAddr)

Do a lookup on the routing table with a destination IPv6 address to obtain an outgoing interface and a next hop Ipv6 address.
interface index associated with destination. Ipv6GetInterfaceIndexForDestAddress(Node* node node, in6_addr destAddr)

Get interface for the destination address.

interface index associated with destination. Ipv6GetMetricForDestAddress(Node* node node, in6_addr destAddr)

Get the cost metric for a destination from the forwarding table.
Interface index associated with destination if found, Ipv6IpGetInterfaceIndexForNextHop(Node* node node, in6_addr destAddr)

This function looks at the network address of each of a node's network interfaces. When nextHopAddress is matched to a network, the interface index corresponding to the network is returned.
Ipv6RouterFunctionType Ipv6GetRouterFunction(Node* node, int interfaceIndex)

Get the router function pointer.

void Ipv6SendPacketToMacLayer(Node* node node, Message* msg, in6_addr destAddr, in6_addr* nextHopAddr, int* interfaceIndex)

Used if IPv6 next hop address and outgoing interface is known.

void Ipv6JoinMulticastGroup(Node* node, in6_addr mcastAddr, clocktype delay)

Join a multicast group.

void Ipv6AddToMulticastGroupList(Node* node, in6_addr groupAddress)

Add group to multicast group list.

void Ipv6LeaveMulticastGroup(Node* node, in6_addr mcastAddr)

Leave a multicast group.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

void

Ipv6RemoveFromMulticastGroupList(Node* node, in6_addr groupAddress)

Remove group from multicast group list.

void Ipv6NotificationOfPacketDrop(Node* node, Message* msg, const NodeAddress nextHopAddress, int interfaceIndex)

Invoke callback functions when a packet is dropped.

TRUE if node is part of multicast group, Ipv6IsPartOfMulticastGroup(Node* node, Message* msg, in6_addr groupAddress)

Check if destination is part of the multicast group.

TRUE if reserved multicast address, FALSE otherwise. Ipv6IsReservedMulticastAddress(Node* node, in6_addr mcastAddr)

Check if address is reserved multicast address.

TRUE if interface is in multicast outgoing interface Ipv6InMulticastOutgoingInterface(Node* node, LinkedList* list, int interfaceIndex)

Determine if interface is in multicast outgoing interface list.

void Ipv6UpdateMulticastForwardingTable(Node* node, in6_addr sourceAddress, in6_addr multicastGroupAddress)

update entry with (sourceAddress, multicastGroupAddress) pair. search for the row with (sourceAddress, multicastGroupAddress) and update its interface.
Interface List if match found, NULL otherwise. Ipv6GetOutgoingInterfaceFromMulticastTable(Node* node, in6_addr sourceAddress, in6_addr groupAddress)

get the interface List that lead to the (source, multicast group) pair.
void Ipv6CreateBroadcastAddress()

Create IPv6 Broadcast Address (ff02 followed by all one).

Prefix Length. Ipv6GetPrefixLength()

Get prefix length of an interface.

void Ipv6SetMacLayerStatusEventHandlerFunction(Node* node, Ipv6MacLayerStatusEventHandlerFunctionType StatusEventHandlerPtr, int interfaceIndex)

Allows the MAC layer to send status messages (e.g., packet drop, link failure) to a network-layer routing protocol for routing optimization.
void Ipv6DeleteOutboundPacketsToANode(Node* node, const in6_addr nextHopAddress, const in6_addr destinationAddress, const BOOL returnPacketsToRoutingProtocol)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Deletes all packets in the queue going to the specified next hop address. There is option to return all such packets back to the routing protocols.
void Ipv6IsLoopbackAddress(Node* node, in6_addr address)

Check if address is self loopback address.

TRUE if my Ip, FALSE otherwise. Ipv6IsMyIp(Node* node, in6_addr* dst_addr)

Check if address is self loopback address.

Scope value if valid multicast address, 0 otherwise. Ipv6IsValidGetMulticastScope(Node* node, in6_addr multiAddr)

Check if multicast address has valid scope.

BOOL IsIPV6RoutingEnabledOnInterface(Node* node, int interfaceIndex)

To check if IPV6 Routing is enabled on interface?

Constant / Data Structure Detail

Constant

MAX_KEY_LEN 128

Constant

Flow infromation version. IPV6_VERSION 6

IPv6 version no.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Constant

IP6_MMTU 1280

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Constant

Mask for fragmenting bits. IP6_FRAGTTL 120

Constant

Time to live for frags. IP6_T_FLAG 0x10

Constant

T Flag if set indicates transient multicast address. Multicast Address Scope Related constants.

Constant

IP_FRAGMENT_HOLD_TIME 60 * SECOND

Constant

Router Advertisement timer. RTR_SOLICITATION_INTERVAL 4 * SECOND

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Constant

Maximum size of Hash-Table MAX_REVLOOKUP_SIZE 100

Constant

Maximum Rev Look up hash table size IP6_LSRRT 0

Constant

type 0 IP6_NIMRT 1

Constant

type 1 IP6_RT_MAX 3

Constant

Maximum number of addresses. IP6ANY_HOST_PROXY 1

Constant

proxy (host) IP6ANY_ROUTER_PROXY 2

Structure

proxy (router) ip6_hdr_struct

Structure

QualNet typedefs struct ip6_hdr_struct to ip6_hdr. struct ip6_hdr_struct is 40 bytes, just like in the BSD code. in6_multi_struct

Structure

QualNet typedefs struct in6_multi_struct to in6_multi. struct in6_multi_struct is just like in the BSD code. ipv6_h2hhdr_struct

Structure

QualNet typedefs struct ipv6_h2hhdr_struct to ipv6_h2hhdr. struct ipv6_h2hhdr_struct is hop-by-Hop Options Header of 14 bytes, just like in the BSD code. ipv6_rthdr_struct

QualNet typedefs struct ipv6_rthdr_struct to ipv6_rthdr. struct ipv6_h2hhdr_struct is routing options header of 8 bytes, just like in the BSD
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Structure

code. ipv6_rthdr_struct

Structure

QualNet typedefs struct ipv6_rthdr_struct to ipv6_rthdr. struct ipv6_h2hhdr_struct is destination options header of 8 bytes, just like in the BSD code. ip_moptions_struct

Structure

QualNet typedefs struct ip_moptions_struct to ip_moptions. struct ip_moptions_struct is multicast option structure, just like in the BSD code. ip6_frag_struct

Structure

QualNet typedefs struct ip6_frag_struct to ipv6_fraghdr. struct ip6_frag_struct is fragmentation header structure. ip6Stat_struct

Structure

QualNet typedefs struct ip6stat_struct to ip6Stat. struct ip6stat_struct is statistic information structure. Ipv6MulticastForwardingTableRow

Structure

Structure of an entity of multicast forwarding table. Ipv6MulticastForwardingTable

QualNet typedefs struct fragmeted_msg_struct to ip6q. struct fragmeted_msg_struct is a simple fragmented packets msg hold structure. defaultRouterList

Structure

default router list structure. destination_route_struct

Structure

QualNet typedefs struct destination_route_struct to destinationRoute. struct destination_route_struct is destination information structure of a node. DestinationCache

Structure

Destination cache entry structure Ipv6HashData

Structure

Ipv6 hash data structure. Ipv6HashBlockData

Structure

Ipv6 hash block-data structure. Ipv6HashBlock

Structure

Ipv6 hash block structure. Ipv6HashTable

Structure

Ipv6 hash table structure IPv6Data

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Structure

QualNet typedefs struct ipv6_data_struct to IPv6Data. struct ipv6_data_struct is ipv6 information structure of a node. ndpNadvEvent

QualNet typedefs struct ndp_event_struct to IPv6Data. struct ndp_event_struct is neighbor advertisement information structure.

Function / Macro Detail Function / Macro ND_DEFAULT_CLASS(0xe0) Format Node Discovery sets class.

NDP_DELAY

NDP neighbor advertisement delay.

IPV6JITTER_RANGE

IPv6 jitter timer.

IPV6_SET_CLASS(hdr, priority)

Sets the flow class.

IPV6_GET_CLASS(hdr)

Gets the flow class.

ip6_hdrSetVersion()

void ip6_hdrSetVersion() (UInt32 ipv6HdrVcf, UInt32 version) Parameters:

Set the value of version for ip6_hdr

ipv6HdrVcf version

- The variable containing the value of ip6_v,ip6_class

- Input value for set operation

Returns:
void

- NULL.

ip6_hdrSetClass()

void ip6_hdrSetClass() (UInt32 ipv6HdrVcf, unsigned char ipv6Class) Parameters:

Set the value of class for ip6_hdr

ipv6HdrVcf ipv6Class

- The variable containing the value of ip6_v,ip6_class

- Input value for set operation

Returns:
void

- NULL.

ip6_hdrSetFlow()

void ip6_hdrSetFlow() (UInt32 ipv6HdrVcf, UInt32 flow)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Parameters: Set the value of flow for ip6_hdr

ipv6HdrVcf flow

- The variable containing the value of ip6_v,ip6_class

- Input value for set operation

Returns:
void

- NULL.

ip6_hdrGetVersion()

UInt32 ip6_hdrGetVersion() (unsigned int ipv6HdrVcf) Parameters:

Returns the value of version for ip6_hdr

ipv6HdrVcf

- The variable containing the value of ip6_v,ip6_class

Returns:
UInt32

- None

ip6_hdrGetClass()

UInt32 ip6_hdrGetClass() (unsigned int ipv6HdrVcf) Parameters:

Returns the value of ip6_class for ip6_hdr

ipv6HdrVcf

- The variable containing the value of ip6_v,ip6_class

Returns:
UInt32

- None

ip6_hdrGetFlow()

UInt32 ip6_hdrGetFlow() (unsigned int ipv6HdrVcf) Parameters:

Returns the value of ip6_flow for ip6_hdr

ipv6HdrVcf

- The variable containing the value of ip6_v,ip6_class

Returns:
UInt32

- None

in6_isanycast

int in6_isanycast (Node* node, in6_addr addr) Parameters:

Checks whether the address is anycast address of the node.

node addr

- Pointer to node structure. - ipv6 address.

Returns:
int

- None

Ipv6AddIpv6Header

None Ipv6AddIpv6Header (Node* node, Message* msg, in6_addr srcaddr, in6_addr dst_addr, TosType priority, unsigned char protocol, unsigned hlim)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Parameters: Add an IPv6 packet header to a message. Just calls AddIpHeader.

node msg

- Pointer to node.

- Pointer to message. - Source IPv6 address. - Destination IPv6 address. - Current type of service - IPv6 protocol number.

srcaddr

dst_addr priority protocol hlim

- Hop limit.

Returns:
None

- None

Ipv6AddFragmentHeader

None Ipv6AddFragmentHeader (Node *node node, Message *msg msg, unsigned char nextHeader, unsigned short offset, unsigned int id) Parameters:

Adds fragment header

node msg

- Pointer to node

- Pointer to Message - nextHeader

nextHeader offset id

- offset

- id

Returns:
None

- None

Ipv6RemoveIpv6Header

None Ipv6RemoveIpv6Header (Node *node node, Message *msg msg, Address* sourceAddress, Address* destinationAddress destinationAddress, TosType *priority priority, unsigned char *protocol protocol, unsigned *hLim hLim) Parameters:
node msg

Removes Ipv6 header

- Pointer to node

- Pointer to message - Poineter Source address - Destination address

sourceAddress

destinationAddress priority
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

- Priority

IPv6

protocol hLim

- protocol

- hLim

Returns:
None

- None

Ipv6PreInit

None Ipv6PreInit (Node* node) Parameters:

IPv6 Pre Initialization.

node

- Pointer to node structure.

Returns:
None

- None

IPv6Init

None IPv6Init (Node* node, const NodeInput* nodeInput) Parameters:

IPv6 Initialization.

node

- Pointer to node structure. - Node input.

nodeInput

Returns:
None

- None

Ipv6IsMyPacket

BOOL Ipv6IsMyPacket (Node* node, in6_addr* dst_addr) Parameters:

Checks whether the packet is the nodes packet. if the packet is of the node then returns TRUE, otherwise FALSE.

node

- Pointer to node structure. - ipv6 packet destination address.

dst_addr

Returns:
BOOL

globalAddr tla nla sla

- Top level id. - Next level id. - Site level id. - Pointer to new interface index.

newinterfaceIndex nodeInput

- Node Input.

Returns:
None

- None

Ipv6IsForwardingEnabled

BOOL Ipv6IsForwardingEnabled (IPv6Data* ipv6) Parameters:

Checks whether the node is forwarding enabled.

ipv6

- Pointer to ipv6 data structure.

Returns:
BOOL

- None

Ipv6Layer

None Ipv6Layer (Node* node, Message* msg) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Handle IPv6 layer events, incoming messages and messages sent to itself (timers, etc.).

node msg

- Pointer to node.

- Pointer to message.

Returns:
None

- None

Ipv6Finalize

node msg

- Pointer to node.

- Pointer to message with IPv6 packet. - Packet's next hop link layer address. - Packet's destination address.

nextHopAddress

destinationAddress

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

outgoingInterface networkType queueIsFull

- Used to determine where packet

- Type of network packet is using (IPv6, - Storage for boolean indicator.

Returns:
None

- None

Ipv6InputQueueInsert

None Ipv6InputQueueInsert (Node* node, int incomingInterface, Message* msg, NodeAddress nextHopAddress, in6_addr destinationAddress, int outgoingInterface, int networkType, BOOL* queueIsFull) Parameters:

node

- Pointer to node. - interface of input queue.

incomingInterface msg

- Pointer to message with IPv6 packet. - Packet's next hop link layer address. - Packet's destination address.

nextHopAddress

destinationAddress outgoingInterface networkType queueIsFull

- Used to determine where packet

- Type of network packet is using (IPv6, - Storage for boolean indicator.

Returns:
None

- None

Ipv6OutputQueueInsert

None Ipv6OutputQueueInsert (Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull) Parameters:

node

- Pointer to node. - interface of input queue.

interfaceIndex msg

- Pointer to message with IPv6 packet. - Packet's next link layer hop address. - Packet's destination address.

nextHopAddress

destinationAddress networkType queueIsFull

- Type of network packet is using (IPv6, - Storage for boolean indicator.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

None

- None

QueueUpIpv6FragmentForMacLayer

None QueueUpIpv6FragmentForMacLayer (Node* node, int interfaceIndex, Message* msg, NodeAddress nextHopAddress, NodeAddress destinationAddress, int networkType, BOOL* queueIsFull) Parameters:

node

- Pointer to node. - interface of input queue.

interfaceIndex msg

- Pointer to message with IPv6 packet. - Packet's next hop address. - Packet's destination address.

nextHopAddress

destinationAddress networkType queueIsFull

- Type of network packet is using (IPv6, - Storage for boolean indicator.

Returns:
None

- None

Ipv6SendPacketOnInterface

None Ipv6SendPacketOnInterface (Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress nextHop) Parameters:

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of incoming interface.

incommingInterface outgoingInterface nextHop

- Index of outgoing interface.

- Next hop link layer address.

Returns:
None

- None

Ipv6SendOnBackplane

None Ipv6SendOnBackplane (Node* node, Message* msg, int incommingInterface, int outgoingInterface, NodeAddress hopAddr) Parameters:

This function is called when the packet delivered through backplane delay. required,before calling the next function.

node msg

- Pointer to node.

- Pointer to message with ip packet. - Index of incomming interface.

incommingInterface
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

outgoingInterface hopAddr

- Index of outgoing interface.

- Next hop link layer address.

Returns:
None

- None

Ipv6SendRawMessage

None Ipv6SendRawMessage (Node* node, Message* msg, in6_addr sourceAddress, in6_addr destinationAddress, int outgoingInterface, TosType priority, unsigned char protocol, unsigned ttl) Parameters:

Called by NetworkIpReceivePacketFromTransportLayer() to send to send UDP datagrams using IPv6. This function adds an IPv6 header and calls RoutePacketAndSendToMac().

node msg

- Pointer to node.

- Pointer to message with payload data - Source IPv6 address. - Destination IPv6 address.

sourceAddress

destinationAddress outgoingInterface priority protocol ttl

- outgoing interface to use to

- Priority of packet. - IPv6 protocol number.

- Time to live.

Returns:
None

- None

Ipv6SendToUdp

None Ipv6SendToUdp (Node* node, Message* msg, TosType priority, Address sourceAddress, Address destinationAddress, int incomingInterfaceIndex) Parameters:

Sends a UDP packet to UDP in the transport layer. The source IPv6 address, destination IPv6 address, and priority of the packet are also sent.

node msg

- Pointer to node.

- Pointer to message with UDP packet. - Priority of UDP - Source IP address info. - Destination IP address info. - interface that received the packet

priority

sourceAddress

destinationAddress

incomingInterfaceIndex

Returns:
None

- None

Ipv6SendToTCP

None Ipv6SendToTCP (Node* node, Message* msg, TosType priority, Address sourceAddress,

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Address destinationAddress, int incomingInterfaceIndex) Parameters: Sends a TCP packet to UDP in the transport layer. The source IPv6 address, destination IPv6 address, and priority of the packet are also sent.
node msg

- Pointer to node.

- Pointer to message with UDP packet. - Priority of TCP - Source IP address info. - Destination IP address info. - interface that received the packet

priority

sourceAddress

destinationAddress

incomingInterfaceIndex

Returns:
None

- None

Ipv6ReceivePacketFromMacLayer

None Ipv6ReceivePacketFromMacLayer (Node* node, Message* msg, NodeAddress previousHopNodeId, int interfaceIndex) Parameters:

IPv6 received IPv6 packet from MAC layer. Determine whether the packet is to be delivered to this node, or needs to be forwarded.

node msg

- Pointer to node.

- Pointer to message with ip packet. - nodeId of the previous hop.

previousHopNodeId interfaceIndex

- Index of interface on which packet arrived.

Returns:
None

- None

Ipv6AddMessageInBuffer

BOOL Ipv6AddMessageInBuffer (Node* node, Message* msg, in6_addr* nextHopAddr, int inCommingInterface) Parameters:

Adds an ipv6 packet in message in the hold buffer

node msg

- Pointer to node structure.

- Pointer to message with ip packet. - Source IPv6 address. - Incoming interface

nextHopAddr

inCommingInterface

Returns:
BOOL

- None

Ipv6DeleteMessageInBuffer

BOOL Ipv6DeleteMessageInBuffer (Node* node, messageBuffer* mBuf)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

Ipv6SolicitationMulticastAddress

None Ipv6SolicitationMulticastAddress (in6_addr* dst_addr, in6_addr* target) Parameters:

Copies multicast solicitation address.

dst_addr target

- ipv6 address pointer.

- ipv6 multicast address pointer.

Returns:
None
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

- None

IPv6

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

Ipv6RoutingStaticEntry

None Ipv6RoutingStaticEntry (Node *node node, char currentLine[] currentLine) Parameters:

Static routing route entry function

node

- Pointer to node - Static entry's current line.

currentLine
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Returns:
None

- None

Ipv6AddDestination

None Ipv6AddDestination (Node* node node, route* ro ro) Parameters:

Adds destination in the destination cache.

node ro

- Pointer to node

- Pointer to destination route.

Returns:
None

- None

Ipv6DeleteDestination

None Ipv6DeleteDestination (Node* node node) Parameters:

Deletes destination from the destination cache.

node

- Pointer to node

Returns:
None

- None

Ipv6CheckForValidPacket

int Ipv6CheckForValidPacket (Node* node node, SchedulerType* scheduler scheduler, unsigned int* pIndex pIndex) Parameters:

Checks the packet's validity

node

- Pointer to node - pointer to scheduler

scheduler pIndex

- packet index

Returns:
int

- None

Ipv6NdpProcessing

None Ipv6NdpProcessing (Node* node node) Parameters:

Ipv6 Destination cache and neighbor cache : processing function

node

- Pointer to node

Returns:
None

- None

Ipv6UpdateForwardingTable

None Ipv6UpdateForwardingTable (Node* node node, in6_addr destPrefix destPrefix, in6_addr nextHopPrefix nextHopPrefix, int interfaceIndex, int metric metric) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Updates Ipv6 Forwarding Table

node

- Pointer to node - IPv6 destination address - IPv6 next hop address for this destination - interfaceIndex

destPrefix

nextHopPrefix

interfaceIndex metric

- hop count between source and destination

address

Returns:
Interface index associated with specified subnet address.

- None

Ipv6GetInterfaceAndNextHopFromForwardingTable

void Ipv6GetInterfaceAndNextHopFromForwardingTable (Node* node node, in6_addr destAddr, int* interfaceIndex, in6_addr* nextHopAddr) Parameters:

Do a lookup on the routing table with a destination IPv6

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

address to obtain an outgoing interface and a next hop Ipv6 address.

node

- Pointer to node - Destination Address - Pointer to interface index

destAddr

interfaceIndex nextHopAddr

- Next Hop Addr for destination.

Returns:
Interface index associated with destination if found,

- None

Ipv6GetRouterFunction

Ipv6RouterFunctionType Ipv6GetRouterFunction (Node* node, int interfaceIndex) Parameters:

Get the router function pointer.

node

- Pointer to node.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

interfaceIndex

- interface associated with router function

Returns:
Ipv6RouterFunctionType

- router function pointer.

Ipv6SendPacketToMacLayer

void Ipv6SendPacketToMacLayer (Node* node node, Message* msg, in6_addr destAddr, in6_addr* nextHopAddr, int* interfaceIndex) Parameters:

Used if IPv6 next hop address and outgoing interface is known.

node msg

- Pointer to node

- Pointer to message - Destination Address - Next Hop Addr for destination. - Pointer to interface index

destAddr

nextHopAddr

interfaceIndex

Returns:
void

- NULL.

Ipv6JoinMulticastGroup

void Ipv6JoinMulticastGroup (Node* node, in6_addr mcastAddr, clocktype delay) Parameters:

Join a multicast group.

node

- Pointer to node. - multicast group to join.

mcastAddr delay

- delay.

Returns:
void

- NULL.

Ipv6AddToMulticastGroupList

void Ipv6AddToMulticastGroupList (Node* node, in6_addr groupAddress) Parameters:

Add group to multicast group list.

node

- Pointer to node. - Group to add to multicast group list.

groupAddress

Returns:
void

- NULL.

Ipv6LeaveMulticastGroup

void Ipv6LeaveMulticastGroup (Node* node, in6_addr mcastAddr) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Leave a multicast group.

node

- Pointer to node. - multicast group to leave.

Returns:
TRUE if node is part of multicast group,

- None

Ipv6IsReservedMulticastAddress

TRUE if reserved multicast address, FALSE otherwise. Ipv6IsReservedMulticastAddress (Node* node, in6_addr mcastAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Parameters: Check if address is reserved multicast address.

node

- Pointer to node. - multicast group to join.

mcastAddr

Returns:
TRUE if reserved multicast address, FALSE otherwise.

- None

Ipv6InMulticastOutgoingInterface

TRUE if interface is in multicast outgoing interface Ipv6InMulticastOutgoingInterface (Node* node, LinkedList* list, int interfaceIndex) Parameters:

Determine if interface is in multicast outgoing interface list.

node list

- Pointer to node. - Pointer to Linked List. - Interface Index.

interfaceIndex

Returns:
TRUE if interface is in multicast outgoing interface

- None

Ipv6UpdateMulticastForwardingTable

void Ipv6UpdateMulticastForwardingTable (Node* node, in6_addr sourceAddress, in6_addr multicastGroupAddress) Parameters:

update entry with (sourceAddress, multicastGroupAddress) pair. search for the row with (sourceAddress, multicastGroupAddress) and update its interface.

node

- Pointer to node. - Source Address. - multicast group.

sourceAddress

multicastGroupAddress

Returns:
void

- NULL.

Ipv6GetOutgoingInterfaceFromMulticastTable

Interface List if match found, NULL otherwise. Ipv6GetOutgoingInterfaceFromMulticastTable (Node* node, in6_addr sourceAddress, in6_addr groupAddress) Parameters:

get the interface List that lead to the (source, multicast group) pair.

node

- Pointer to node. - Source Address

sourceAddress groupAddress

- multicast group address

Returns:
Interface List if match found, NULL otherwise.

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Ipv6CreateBroadcastAddress

void Ipv6CreateBroadcastAddress () Parameters:

Create IPv6 Broadcast Address (ff02 followed by all one). Ipv6GetPrefixLength

Returns:
void

- NULL.

Prefix Length. Ipv6GetPrefixLength () Parameters:

Get prefix length of an interface.

Returns:
Prefix Length.

- None

Ipv6SetMacLayerStatusEventHandlerFunction

void Ipv6SetMacLayerStatusEventHandlerFunction (Node* node, Ipv6MacLayerStatusEventHandlerFunctionType StatusEventHandlerPtr, int interfaceIndex) Parameters:

Allows the MAC layer to send status messages (e.g., packet drop, link failure) to a network-layer routing protocol for routing optimization.

node

- Pointer to node. - Function Pointer

StatusEventHandlerPtr interfaceIndex

- Interface Index

Returns:
void

- NULL.

Ipv6DeleteOutboundPacketsToANode

void Ipv6DeleteOutboundPacketsToANode (Node* node, const in6_addr nextHopAddress, const in6_addr destinationAddress, const BOOL returnPacketsToRoutingProtocol) Parameters:

Deletes all packets in the queue going to the specified next hop address. There is option to return all such packets back to the routing protocols.

node

- Pointer to node. - Next Hop Address. - Destination Address - bool

nextHopAddress

destinationAddress

returnPacketsToRoutingProtocol

Returns:
void

- NULL.

Ipv6IsLoopbackAddress

void Ipv6IsLoopbackAddress (Node* node, in6_addr address) Parameters:

Check if address is self loopback address.

node

- Pointer to node. - ipv6 address

address
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

interfaceIndex

Returns:
BOOL

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

IPv6

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/IPv6.html[5/24/2011 12:35:23 PM]

LIST

EXata 2.2 API Specification

LIST
This file describes the data structures and functions used in the implementation of lists. Constant / Data Structure Summary Type
STRUCT

Name
ListItem template

Structure for each item of a generic container list

STRUCT List

A list that stores different types of structures.

STRUCT IntList

A list that stores integers.

Function / Macro Summary Return Type

void

Summary
ListInit(Node* node, LinkedList** list)

Initialize the list

BOOL ListIsEmpty(Node* node, LinkedList* list)

Check if list is empty

int ListGetSize(Node* node, LinkedList* list)

Get the size of the list

void ListInsert(Node* node, LinkedList* list, clocktype timeStamp, void* data)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

Insert an item at the end of the list

void* FindItem(Node* node, List* list, int byteSkip, char* key, int size)

Find an item from the list

void* FindItem(Node* node, List* list, int byteSkip, char* key, int size)

Find an item from the list

void ListGet(Node* node, List* list, ListItem* listItem, BOOL freeItem, BOOL isMsg)

Remove an item from the list

void ListFree(Node* node, List* list, BOOL isMsg)

Free the entire list

void IntListInit(Node* node, IntList** list)

Initialize the list

BOOL IntListIsEmpty(Node* node, IntList* list)

Check if list is empty

int IntListGetSize(Node* node, IntList* list)

Get the size of the list

void ListInsert(Node* node, List* list, clocktype timeStamp, void* data)

Insert an item at the end of the list

void IntListGet(Node* node, IntList* list, IntListItem* listItem, BOOL freeItem, BOOL isMsg)

Remove an item from the list

void IntListFree(Node* node, IntList* list, BOOL isMsg)

Free the entire list

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

Constant / Data Structure Detail

Structure

ListItem template

Structure

Structure for each item of a generic container list List

Structure

A list that stores different types of structures. IntList

A list that stores integers.

Function / Macro Detail Function / Macro ListInit Format void ListInit (Node* node, LinkedList** list) Parameters: Initialize the list
node list

- Node that contains the list - Pointer to list pointer

Returns:
void

- NULL

ListIsEmpty

BOOL ListIsEmpty (Node* node, LinkedList* list) Parameters:

Check if list is empty

node list

- Node that contains the list - Pointer to the list

Returns:
BOOL

- If empty, TRUE, non-empty, FALSE

ListGetSize

int ListGetSize (Node* node, LinkedList* list) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

Get the size of the list

node list

- Pointer to the node containing the list - Pointer to the list

Returns:
int

- Size of the list

ListInsert

void ListInsert (Node* node, LinkedList* list, clocktype timeStamp, void* data) Parameters:

Insert an item at the end of the list

node list

- Pointer to the node containing the list - Pointer to the list - Time the item was last inserted.

timeStamp data

- item to be inserted

Returns:
void

- NULL

FindItem

void* FindItem (Node* node, List* list, int byteSkip, char* key, int size) Parameters:

Find an item from the list

node list

- Pointer to the node containing the list - Pointer to the list - How many bytes skip to get the key item

byteSkip key

- The key that an item is idendified. - Size of the key element in byte

size

Returns:
void*

- Item found, NULL if not found

FindItem

void* FindItem (Node* node, List* list, int byteSkip, char* key, int size) Parameters:

Find an item from the list

node list

- Pointer to the node containing the list - Pointer to the list - How many bytes skip to get the key item

byteSkip key

- The key that an item is idendified. - Size of the key element in byte

size

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

Returns:
void*

- Item found, NULL if not found

ListGet

void ListGet (Node* node, List* list, ListItem* listItem, BOOL freeItem, BOOL isMsg) Parameters:

Remove an item from the list

node list

- Pointer to the node containing the list - Pointer to the list to remove item from - item to be removed - Whether to free the item

listItem freeItem isMsg

- Whether is this item a message? If it is

Returns:
void

- NULL

ListFree

void ListFree (Node* node, List* list, BOOL isMsg) Parameters:

Free the entire list

node list

- Pointer to the node containing the list - Pointer to the list to be freed - Does the list contain Messages? If so, we

isMsg

Returns:
void

- NULL

IntListInit

void IntListInit (Node* node, IntList** list) Parameters:

Initialize the list

node list

- Node that contains the list - Pointer to list pointer

Returns:
void

- NULL

IntListIsEmpty

BOOL IntListIsEmpty (Node* node, IntList* list) Parameters:

Check if list is empty

node

- Node that contains the list

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

list

- Pointer to the list

Returns:
BOOL

- If empty, TRUE, non-empty, FALSE

IntListGetSize

int IntListGetSize (Node* node, IntList* list) Parameters:

Get the size of the list

node list

- Pointer to the node containing the list - Pointer to the list

Returns:
int

- Size of the list

ListInsert

void ListInsert (Node* node, List* list, clocktype timeStamp, void* data) Parameters:

Insert an item at the end of the list

node list

- Pointer to the node containing the list - Pointer to the list - Time the item was last inserted.

timeStamp data

- item to be inserted

Returns:
void

- NULL

IntListGet

void IntListGet (Node* node, IntList* list, IntListItem* listItem, BOOL freeItem, BOOL isMsg) Parameters:

Remove an item from the list

node list

- Pointer to the node containing the list - Pointer to the list to remove item from - item to be removed - Whether to free the item

listItem freeItem isMsg

- Whether is this item a message? If it is

Returns:
void

- NULL

IntListFree

void IntListFree (Node* node, IntList* list, BOOL isMsg) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

LIST

Free the entire list

node list

- Pointer to the node containing the list - Pointer to the list to be freed - Does the list contain Messages? If so, we

isMsg

Returns:
void

- NULL

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/LIST.html[5/24/2011 12:35:32 PM]

MAC LAYER

EXata 2.2 API Specification

MAC LAYER
This file describes data structures and functions used by the MAC Layer. Constant / Data Structure Summary Type
CONSTANT

Name
MAC_PROPAGATION_DELAY

Peer to Peer Propogation delay in the MAC

CONSTANT MAC_ADDRESS_LENGTH_IN_BYTE

MAC address length

CONSTANT Max_MacAdress_Length

Maximum MAC address length

CONSTANT MAC_ADDRESS_DEFAULT_LENGTH

MAC address length in byte or octets

CONSTANT MAC_CONFIGURATION_ATTRIBUTE

Number of attribute of mac address file

CONSTANT HW_TYPE_NETROM

From KA9Q NET/ROM pseudo Hardware type.

CONSTANT HW_TYPE_ETHER

Ethernet 10/100Mbps Hardware type Ethernet.

CONSTANT HW_TYPE_EETHER

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Hardware type Experimental Ethernet

CONSTANT HW_TYPE_AX25

Hardware type AX.25 Level 2

CONSTANT HW_TYPE_PRONET

Hardware type PROnet token ring

CONSTANT HW_TYPE_CHAOS

Hardware type Chaosnet

CONSTANT HW_TYPE_IEEE802

IEEE 802.2 Ethernet/TR/TB

CONSTANT HW_TYPE_ARCNET

Hardware type ARCnet

CONSTANT HW_TYPE_APPLETLK

Hardware type APPLEtalk

CONSTANT HW_TYPE_DLCI

Frame Relay DLCI

CONSTANT HW_TYPE_ATM

ATM 10/100Mbps
CONSTANT HW_TYPE_METRICOM

Hardware type HW_TYPE_METRICOM

CONSTANT HW_TYPE_IEEE_1394

Hardware type IEEE_1394

CONSTANT HW_TYPE_EUI_64

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Hardware identifier
CONSTANT HW_TYPE_UNKNOWN

Unknown Hardware type MAC protocol HARDWARE identifiers.

CONSTANT MAC_IPV4_LINKADDRESS_LENGTH

Length of 4 byte MacAddress

CONSTANT MAC_NODEID_LINKADDRESS_LENGTH

Length of 2 byte MacAddress

CONSTANT IPV4_LINKADDRESS

Hardware identifier
CONSTANT HW_NODE_ID

Hardware identifier
CONSTANT INVALID_MAC_ADDRESS

INVALID MAC ADDRESS

CONSTANT STATION_VLAN_TAGGING_DEFAULT

Default VLAN TAGGING Value for a STATION node

ENUMERATION MacInterfaceState

Describes one out of two possible states of MAC interface - enable or disable
ENUMERATION MacLinkType

Describes different link type

ENUMERATION MAC_PROTOCOL

Specifies different MAC_PROTOCOLs used

ENUMERATION MAC_SECURITY

Specifies different MAC_SECURITY_PROTOCOLs used

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

ENUMERATION

ManagementRequestType

Type of management request message

ENUMERATION ManagementResponseType

Type of management response message

ENUMERATION MacLinkType

Describes different fault type

STRUCT MacHWAddress

MAC hardware address of variable length

STRUCT Mac802Address

MAC address of size MAC_ADDRESS_LENGTH_IN_BYTE. It is default Mac address of type 802

STRUCT MacVlan

Structure of VLAN in MAC sublayer

STRUCT MacHeaderVlanTag

Structure of MAC sublayer VLAN header

STRUCT MacData

A composite structure representing MAC sublayer which is typedefed to MacData in main.h

STRUCT ManagementRequest

data structure of management request

STRUCT ManagementResponse

data structure of management response

STRUCT MacToPhyPacketDelayInfoType

Specifies the MAC to Physical layer delay information structure

STRUCT MacFaultInfo
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Fields for keeping track of interface faults

STRUCT RandFault

Structure containing random fault information.

Function / Macro Summary Return Type

MACRO

Summary
MAC_EnableInterface(node, interfaceIndex)

Enable the MAC_interface

MACRO MAC_DisableInterface(node, interfaceIndex)

Disable the MAC_interface

MACRO MAC_ToggleInterfaceStatus(node, interfaceIndex)

Toggle the MAC_interface status

MACRO MAC_InterfaceIsEnabled(node, interfaceIndex)

To query MAC_interface status is enabled or not

void MacReportInterfaceStatus(Node* node, int interfaceIndex, MacInterfaceState state)

Callback funtion to report interface status

void MAC_SetInterfaceStatusHandlerFunction(Node* node, int interfaceIndex, MacReportInterfaceStatus statusHandler)

Set the MAC interface handler function to be called when interface faults occurs
MacReportInterfaceStatus MAC_GetInterfaceStatusHandlerFunction(Node* node, int interfaceIndex)

To get the MACInterface status handling function for the system

void MacHasFrameToSendFn(Node* node, int interfaceIndex)

Callback funtion for sending packet. It calls when network layer has packet to send.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

void

MacReceiveFrameFn(Node* node, int interfaceIndex, Message* msg)

Callback funtion to receive packet.

void MAC_NetworkLayerHasPacketToSend(Node* node, int interfaceIndex)

Handles packets from the network layer when the network queue is empty
void MAC_SwitchHasPacketToSend(Node* node, int interfaceIndex)

To inform MAC that the Switch has packets to to send

void MAC_ReceivePacketFromPhy(Node* node, int interfaceIndex, Message* packet)

Handles packets received from physical layer

void MAC_ManagementRequest(Node* node, int interfaceIndex, ManagementRequest* req, ManagementResponse* resp)

Deliver a network management request to the MAC

void MAC_ReceivePhyStatusChangeNotification(Node* node, int interfaceIndex, PhyStatusType oldPhyStatus, PhyStatusType newPhyStatus, clocktype receiveDuration, Message* potentialIncomingPacket)

Handles status changes received from the physical layer

void MAC_InitUserMacProtocol(Node* node, NodeInput nodeInput, const char* macProtocolName, int interfaceIndex)

Initialisation function for the User MAC_protocol

void MacFinalizeUserMacProtocol(Node* node, int interfaceIndex)

Finalization function for the User MAC_protocol

void MAC_HandleUserMacProtocolEvent(Node* node, int interfaceIndex, Message* packet)

Handles the MAC protocol event

BOOL MAC_OutputQueueIsEmpty(Node* node, int interfaceIndex)

To check if Output queue for an interface of a node if empty or not

void MAC_NotificationOfPacketDrop(Node* node, NodeAddress nextHopAddress, int interfaceIndex, Message* msg)

To notify MAC of packet drop

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

void

MAC_NotificationOfPacketDrop(Node* node, MacHWAddress nextHopAddress, int interfaceIndex, Message* msg)

To notify MAC of packet drop

void MAC_NotificationOfPacketDrop(Node* node, Mac802Address nextHopAddress, int interfaceIndex, Message* msg)

To notify MAC of packet drop

BOOL MAC_OutputQueueTopPacketForAPriority(Node* node, int interfaceIndex, TosType priority, Message** msg, NodeAddress nextHopAddress)

To notify MAC of priority packet arrival

BOOL MAC_OutputQueueTopPacketForAPriority(Node* node, int interfaceIndex, TosType priority, Message** msg, Mac802Address* nextHopAddress)

To notify MAC of priority packet arrival

BOOL MAC_OutputQueueTopPacketForAPriority(Node* node, int interfaceIndex, TosType priority, Message** msg, MacHWAddress* nextHopAddress)

To notify MAC of priority packet arrival

BOOL MAC_OutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, TosType priority, Message** msg, NodeAddress* nextHopAddress, int* networkType)

To remove the packet at the front of the specified priority output queue
BOOL MAC_OutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, TosType priority, Message** msg, MacHWAddress* nextHopAddress, int* networkType)

To remove the packet at the front of the specified priority output queue
BOOL MAC_OutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, TosType* priority, Message** msg, MacHWAddress* destMacAddr, int* networkType, int* packType)

To allow a peek by network layer at packet before processing It is overloading function used for ARP packet
BOOL MAC_OutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, TosType* priority, Message** msg, Mac802Address* destMacAddr, int* networkType, int* packType)

To allow a peek by network layer at packet before processing It is overloading function used for ARP packet
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

void

MAC_SneakPeekAtMacPacket(Node* node, int interfaceIndex, const Message* msg, NodeAddress prevHop, NodeAddress destAddr, int messageType)

To allow a peek by network layer at packet before processing

void MAC_SneakPeekAtMacPacket(Node* node, int interfaceIndex, const Message* msg, MacHWAddress prevHop, MacHWAddress destAddr, int arpMessageType)

To allow a peek by network layer at packet before processing

void MAC_SneakPeekAtMacPacket(Node* node, int interfaceIndex, const Message* msg, Mac802Address prevHop, Mac802Address destAddr, int messageType)

To allow a peek by network layer at packet before processing

void MAC_MacLayerAcknowledgement(Node* node, int interfaceIndex, Message* msg, NodeAddress nextHop)

To send acknowledgement from MAC

void MAC_MacLayerAcknowledgement(Node* node, int interfaceIndex, Message* msg, MacHWAddress& nextHop)

To send acknowledgement from MAC

void MAC_MacLayerAcknowledgement(Node* node, int interfaceIndex, Message* msg, Mac802Address& nextHop)

To send acknowledgement from MAC

void MAC_HandOffSuccessfullyReceivedPacket(Node* node, int interfaceIndex, Message* msg, NodeAddress lastHopAddress)

Pass packet successfully up to the network layer

void MAC_HandOffSuccessfullyReceivedPacket(Node* node, int interfaceIndex, Message* msg, MacHWAddress* lastHopAddr)

Pass packet successfully up to the network layer

void MAC_HandOffSuccessfullyReceivedPacket(Node* node, int interfaceIndex, Message* msg, Mac802ddress* lastHopAddr)

Pass packet successfully up to the network layer

void MAC_HandOffSuccessfullyReceivedPacket(Node* node, int interfaceIndex, Message* msg, MacHWAddress* lastHopAddress, int arpMessageType)

Pass packet successfully up to the network layer It is overloading function used for ARP packet
void MAC_HandOffSuccessfullyReceivedPacket(Node* node, int interfaceIndex, Message* msg, Mac802Address* lastHopAddress, int arpMessageType)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Pass packet successfully up to the network layer It is overloading function used for ARP packet
BOOL MAC_OutputQueueTopPacket(Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int networkType, TosType* priority)

To check packet at the top of output queue

BOOL MAC_OutputQueueTopPacket(Node* node, int interfaceIndex, Message** msg, MacHWAddress* nextHopAddress, int networkType, TosType* priority)

To check packet at the top of output queue

BOOL MAC_OutputQueueTopPacket(Node* node, int interfaceIndex, Message** msg, Mac802Address* nextHopAddress, int networkType, TosType* priority)

To check packet at the top of output queue

BOOL MAC_OutputQueueDequeuePacket(Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int networkType, TosType * priority)

To remove packet from front of output queue

BOOL MAC_OutputQueueDequeuePacket(Node* node, int interfaceIndex, Message** msg, MacHWAddress* nextHopAddress, int networkType, TosType * priority)

To remove packet from front of output queue

BOOL MAC_OutputQueueDequeuePacket(Node* node, int interfaceIndex, Message** msg, Mac802Address* nextHopAddress, int networkType, TosType * priority)

To remove packet from front of output queue, Its a overloaded function

BOOL MAC_OutputQueueDequeuePacket(Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, TosType * priority, MacOutputQueueDequeueOption dequeueOption, MacOutputQueueDequeueCriteria dequeueCriteria, int * numFreeByte, int* numPacketPacked, TraceProtocolType tracePrt, BOOL eachWithMacHeader, int maxHeaderSize, BOOL returnPackedMsg)

To remove packet(s) from front of output queue; process packets with options for example, pakcing multiple packets with same next hop address together
BOOL MAC_OutputQueueDequeuePacketForAPriority(Node* node, int interfaceIndex, int priority, Message** msg, NodeAddress* nextHopAddress, int* networkType, MacOutputQueueDequeueOption dequeueOption, MacOutputQueueDequeueCriteria dequeueCriteria, int * numFreeByte, int* numPacketPacked, TraceProtocolType tracePrt, BOOL eachWithMacHeader, int maxHeaderSize, BOOL returnPackedMsg)

To remove packet(s) from front of output queue; process packets with options for example, pakcing multiple packets with same next hop address together
BOOL MAC_IsMyUnicastFrame(Node* node, NodeAddress destAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Check if a packet (or frame) belongs to this node Should be used only for four byte mac address
BOOL MAC_IsWiredNetwork(Node* node, int interfaceIndex)

To check if an interface is a wired interface

BOOL MAC_IsPointToPointNetwork(Node* node, int interfaceIndex)

Checks if an interface belongs to Point to PointNetwork

BOOL MAC_IsPointToMultiPointNetwork(Node* node, int interfaceIndex)

Checks if an interface belongs to Point to Multi-Point network.

BOOL MAC_IsWiredBroadcastNetwork(Node* node, int interfaceIndex)

Determines if an interface is a wired broadcast interface

BOOL MAC_IsWirelessNetwork(Node* node, int interfaceIndex)

Determine if a node's interface is a wireless interface

BOOL MAC_IsWirelessAdHocNetwork(Node* node, int interfaceIndex)

Determine if a node's interface is a possible wireless ad hoc interface

BOOL MAC_IsOneHopBroadcastNetwork(Node* node, int interfaceIndex)

Determines if an interface is a single Hop Broadcast interface

BOOL MAC_IsASwitch(Node* node)

To check if a node is a switch

void MAC_SetVirtualMacAddress(Node* node, int interfaceIndex, NodeAddress virtualMacAddress)

To set MAC address

void MacSetDefaultHWAddress(Node* node, MacHWAddress* macAddr, int interfaceIndex)

Set Default interface Hardware Address of node

NodeAddress MAC_IsMyMacAddress(Node* node, int interfaceIndex, NodeAddress destAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

To check if received mac address belongs to itself

BOOL MAC_IsMyHWAddress(Node* node, int interfaceIndex, MacAddress* macAddr)

Checks for own MAC address.

void MacValidateAndSetHWAddress(char* macAddrStr, MacHWAddress* macAddr)

Validate MAC Address String after fetching from user

NodeAddress DefaultMacHWAddressToIpv4Address(Node* node, MacHWAddress* macAddr)

Retrieve the IP Address from Default HW Address . Default HW address is equal to 6 bytes
void MacGetHardwareLength(Node* node, int interface, unsigned short hwLength)

Retrieve the Hardware Length.

void MacGetHardwareType(Node* node, int interface, unsigned short* type)

Retrieve the Hardware Type.

void MacGetHardwareAddressString(Node* node, int interface)

Retrieve the Hardware Address String.

void MacAddNewInterface(Node* node, NodeAddress interfaceAddress, int numHostBits, int* interfaceIndex, const NodeInput nodeInput, char* macProtocolName)

To add a new Interface at MAC

void MacAddVlanInfoForThisInterface(Node* node, int* interfaceIndex, NodeAddress interfaceAddress, const NodeInput nodeInput)

Init and read VLAN configuration from user input for node and interface passed as arguments
NodeAddress MacReleaseVlanInfoForThisInterface(Node* node, int interfaceIndex)

To flush VLAN info for an interface

BOOL MAC_IsBroadcastHWAddress(MacHWAddress* macAddr)

Checks Broadcast MAC address

BOOL MAC_IsIdenticalHWAddress(MacHWAddress* macAddr1, MacHWAddress* macAddr2)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Compares two MAC addresses

void MAC_PrintHWAddr(MacHWAddress* macAddr)

Prints interface Mac Address

void MAC_PrintMacAddr(Mac802Address* macAddr)

Prints interface Mac Address

void MAC_RandFaultInit(Node* node, int interfaceIndex, const char* currentLine)

Initialization the Random Fault structure from input file

void MAC_RandFaultFinalize(Node* node, int interfaceIndex)

IPrint the statistics of Random link fault.

TosType MAC_GetPacketsPriority(Message* msg)

Returns the priority of the packet

void MAC_TranslateMulticatIPv4AddressToMulticastMacAddress(NodeAddress multcastAddress, MacHWAddress* macMulticast)

Convert the Multicast ip address to multicast MAC address

BOOL MAC_OutputQueuePeekByIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress nextHopAddress, TosType priority)

Look at the packet at the index of the output queue.

BOOL MAC_OutputQueuePeekByIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, Mac802Address* nextHopAddress, TosType priority)

Look at the packet at the index of the output queue.

BOOL MAC_OutputQueuePeekByIndex(int interfaceIndex, int msgIndex, Message** msg, MacHWAddress* nextHopAddress, TosType priority)

Look at the packet at the index of the output queue.

BOOL MAC_OutputQueueDequeuePacketWithIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress nextHopAddress, int networkType)

To remove the packet at specified index output queue.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

BOOL

MAC_OutputQueueDequeuePacketWithIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, Mac802Address* nextHopMacAddress, int networkType)

To remove the packet at specified index output queue.

BOOL MAC_OutputQueueDequeuePacketWithIndex(Node* node, int interfaceIndex, int msgIndex, Message** msg, MacHWAddress nextHopMacAddress, int networkType)

To remove the packet at specified index output queue.

BOOL MAC_IPv4addressIsMulticastAddress(NodeAddress ipV4)

Check the given address is Multicast address or not.

BOOL MAC_IsBroadcastMacAddress(MacAddress* macAddr)

Checks Broadcast MAC address.

void IPv4AddressToDefaultMac802Address(Node* node, int index, NodeAddress ipv4Address, Mac802Address* macAddr)

Retrieve the Mac802Address from IP address.

Bool ConvertVariableHWAddressTo802Address(Node* node, MacHWAddress* macHWAddr, Mac802Address* mac802Addr)

Convert Variable Hardware address to Mac 802 addtess

void MAC_CopyMacHWAddress(MacHWAddress* destAddr, MacHWAddress* srcAddr)

Copies Hardware address address

NodeAddress DefaultMac802AddressToIpv4Address(Node* node, Mac802Address* macAddr)

Retrieve IP address from.Mac802Address

BOOL IPv4AddressToHWAddress(Node* node, int interfaceIndex, Message* msg, NodeAddress ipv4Address)

Converts IP address.To MacHWAddress

NodeAddress MacHWAddressToIpv4Address(Node * node, int interfaceIndex, MacHWAddress* macAddr)

This functions converts variable length Mac address to IPv4 address It checks the type of hardware address and based on that conversion is done.
char* decToHex(int dec)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Convert one byte decimal number to hex number.

void MAC_FourByteMacAddressToVariableHWAddress(Node * node, int interfaceIndex, MacHWAddress * macAddr, NodeAddress nodeAddr)

NodeAddress

MAC_VariableHWAddressToFourByteMacAddress(Node* node, MacHWAddress* macAddr)

Retrieve IP address from.MacHWAddress of type IPV4_LINKADDRESS

MacHWAddress GetBroadCastAddress(Node* node, int interfaceIndex)

Returns Broadcast Address of an interface

MacHWAddress GetMacHWAddress(Node* node, int interfaceIndex)

Returns MacHWAddress of an interface

int MacGetInterfaceIndexFromMacAddress(Node* node, MacHWAddress macAddr)

Returns interfaceIndex at which Macaddress is configured

int MacGetInterfaceIndexFromMacAddress(Node* node, Mac802Address macAddr)

Returns interfaceIndex at which Macaddress is configured

int MacGetInterfaceIndexFromMacAddress(Node* node, NodeAddress macAddr)

Returns interfaceIndex at which Macaddress is configured

void MAC_Reset(Node* node, int InterfaceIndex)

Reset the Mac protocols use by the node

void MAC_AddResetFunctionList(Node* node, int InterfaceIndex, void* param)

Add which protocols in the Mac layer to be reset to a fuction list pointer.

Constant / Data Structure Detail

Constant

MAC_PROPAGATION_DELAY 1 * MICRO_SECOND

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Constant

Hardware type Chaosnet HW_TYPE_IEEE802 6

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Constant

IEEE 802.2 Ethernet/TR/TB HW_TYPE_ARCNET 7

Constant

Hardware type ARCnet HW_TYPE_APPLETLK 8

Constant

Specifies the MAC to Physical layer delay information structure MacFaultInfo

Structure

Fields for keeping track of interface faults RandFault

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Structure containing random fault information.

Function / Macro Detail Function / Macro MAC_EnableInterface(node, interfaceIndex) Format Enable the MAC_interface

MAC_DisableInterface(node, interfaceIndex)

Disable the MAC_interface

MAC_ToggleInterfaceStatus(node, interfaceIndex)

Toggle the MAC_interface status

MAC_InterfaceIsEnabled(node, interfaceIndex)

To query MAC_interface status is enabled or not

MacReportInterfaceStatus

void MacReportInterfaceStatus (Node* node, int interfaceIndex, MacInterfaceState state) Parameters:

Callback funtion to report interface status

node

- Pointer to a network node - index of interface

interfaceIndex state

- Wheather it enable or disable

Returns:
void

- None

MAC_SetInterfaceStatusHandlerFunction

void MAC_SetInterfaceStatusHandlerFunction (Node* node, int interfaceIndex, MacReportInterfaceStatus statusHandler) Parameters:

Set the MAC interface handler function to be called when interface faults occurs

node

- Pointer to a network node - index of interface

interfaceIndex statusHandler

- Pointer to status Handler

Returns:
void

- None

MAC_GetInterfaceStatusHandlerFunction

MacReportInterfaceStatus MAC_GetInterfaceStatusHandlerFunction (Node* node, int interfaceIndex) Parameters:

To get the MACInterface status handling function for the system

node

- Pointer to a network node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

interfaceIndex

- index of interface

Returns:
MacReportInterfaceStatus

- Pointer to status handler

MacHasFrameToSendFn

void MacHasFrameToSendFn (Node* node, int interfaceIndex) Parameters:

Callback funtion for sending packet. It calls when network layer has packet to send.

node

- Pointer to node - index of interface

interfaceIndex

Returns:
void

- NULL

MacReceiveFrameFn

void MacReceiveFrameFn (Node* node, int interfaceIndex, Message* msg) Parameters:

Callback funtion to receive packet.

node

- Pointer to node - index of interface

interfaceIndex msg

- Pointer to the message

Returns:
void

- NULL

MAC_NetworkLayerHasPacketToSend

void MAC_NetworkLayerHasPacketToSend (Node* node, int interfaceIndex) Parameters:

Handles packets from the network layer when the network queue is empty

node

- Pointer to a network node - index of interface

interfaceIndex

Returns:
void

- None

MAC_SwitchHasPacketToSend

void MAC_SwitchHasPacketToSend (Node* node, int interfaceIndex) Parameters:

To inform MAC that the Switch has packets to to send

node

- Pointer to a network node - index of interface

interfaceIndex

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

void

- None

MAC_ReceivePacketFromPhy

void MAC_ReceivePacketFromPhy (Node* node, int interfaceIndex, Message* packet) Parameters:

Handles packets received from physical layer

node

- Pointer to a network node - index of interface

interfaceIndex packet

- Pointer to Message

Returns:
void

- None

MAC_ManagementRequest

void MAC_ManagementRequest (Node* node, int interfaceIndex, ManagementRequest* req, ManagementResponse* resp) Parameters:

Deliver a network management request to the MAC

node

- Pointer to a network node - index of interface

interfaceIndex req

- Pointer to a management request - Pointer to a management response

resp

Returns:
void

- None

MAC_ReceivePhyStatusChangeNotification

void MAC_ReceivePhyStatusChangeNotification (Node* node, int interfaceIndex, PhyStatusType oldPhyStatus, PhyStatusType newPhyStatus, clocktype receiveDuration, Message* potentialIncomingPacket) Parameters:
node

Handles status changes received from the physical layer

- Pointer to a network node - index of interface

interfaceIndex oldPhyStatus newPhyStatus

- Old status of physical layer - New status of physical layer - Duration after which received - Pointer to incoming message

receiveDuration

potentialIncomingPacket

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

MAC_InitUserMacProtocol

void MAC_InitUserMacProtocol (Node* node, NodeInput nodeInput, const char* macProtocolName, int interfaceIndex) Parameters:

Initialisation function for the User MAC_protocol

node

- Pointer to a network node - Configured Inputs for the node - MAC protocol name

nodeInput

macProtocolName interfaceIndex

- interface index

Returns:
void

- None

MacFinalizeUserMacProtocol

void MacFinalizeUserMacProtocol (Node* node, int interfaceIndex) Parameters:

Finalization function for the User MAC_protocol

node

- Pointer to a network node - index of interface

interfaceIndex

Returns:
void

- None

MAC_HandleUserMacProtocolEvent

void MAC_HandleUserMacProtocolEvent (Node* node, int interfaceIndex, Message* packet) Parameters:

Handles the MAC protocol event

node

- Pointer to a network node - index of interface

interfaceIndex packet

- Pointer to Message

Returns:
void

- None

MAC_OutputQueueIsEmpty

BOOL MAC_OutputQueueIsEmpty (Node* node, int interfaceIndex) Parameters:

To check if Output queue for an interface of a node if empty or not

node

- Pointer to a network node - index of interface

interfaceIndex

Returns:
BOOL

- Pointer to Message

Returns:
void

- None

MAC_OutputQueueTopPacketForAPriority

BOOL MAC_OutputQueueTopPacketForAPriority (Node* node, int interfaceIndex, TosType priority, Message** msg, NodeAddress nextHopAddress) Parameters:

MAC_OutputQueueDequeuePacketForAPriority

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, TosType priority, Message** msg, NodeAddress* nextHopAddress, int* networkType)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Parameters: To remove the packet at the front of the specified priority output queue
node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- Message Priority

- Pointer to Message - Next hop address

nextHopAddress networkType

- network type

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacketForAPriority

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, TosType priority, Message** msg, MacHWAddress* nextHopAddress, int* networkType) Parameters:

To remove the packet at the front of the specified priority output queue

node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- Message Priority

- Pointer to Message - Next hop mac address

nextHopAddress networkType

- network type

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacketForAPriority

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, TosType priority, Message** msg, Mac802Address* nextHopAddress, int* networkType) Parameters:

To remove the packet at the front of the specified priority output queue

node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- Message Priority

- Pointer to Message - Next hop mac address

nextHopAddress

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

networkType

- network type

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacketForAPriority

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, TosType* priority, Message** msg, MacHWAddress* destMacAddr, int* networkType, int* packType) Parameters:

To allow a peek by network layer at packet before processing It is overloading function used for ARP packet

node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- tos value

- Pointer to Message - Dest addr Pointer - Network Type pointer

destMacAddr networkType packType

- packet Type pointer

Returns:
BOOL

- If success TRUE NOTE : Overloaded MAC_OutputQueueDequeuePacketForAPriority()

MAC_OutputQueueDequeuePacketForAPriority

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, TosType* priority, Message** msg, Mac802Address* destMacAddr, int* networkType, int* packType) Parameters:

To allow a peek by network layer at packet before processing It is overloading function used for ARP packet

node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- tos value

- Pointer to Message - Dest addr Pointer - Network Type pointer

destMacAddr networkType packType

- packet Type pointer

Returns:
BOOL

- If success TRUE NOTE : Overloaded MAC_OutputQueueDequeuePacketForAPriority()

interfaceIndex msg

- Pointer to Message - Pointer to nexthop mac address

- Pointer to Message - mac address

lastHopAddr

Returns:
void

- None

MAC_HandOffSuccessfullyReceivedPacket

void MAC_HandOffSuccessfullyReceivedPacket (Node* node, int interfaceIndex, Message* msg, MacHWAddress* lastHopAddress, int arpMessageType)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Parameters: Pass packet successfully up to the network layer It is overloading function used for ARP packet
node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - mac address - Distinguish between ARP and general message

lastHopAddress arpMessageType

Returns:
void

- NULL

MAC_HandOffSuccessfullyReceivedPacket

void MAC_HandOffSuccessfullyReceivedPacket (Node* node, int interfaceIndex, Message* msg, Mac802Address* lastHopAddress, int arpMessageType) Parameters:

Pass packet successfully up to the network layer It is overloading function used for ARP packet

node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - mac address - Distinguish between ARP and general message

lastHopAddress arpMessageType

Returns:
void

- NULL

MAC_OutputQueueTopPacket

BOOL MAC_OutputQueueTopPacket (Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int networkType, TosType* priority) Parameters:

To check packet at the top of output queue

node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - Next hop address

nextHopAddress networkType priority

- network type

- Message Priority

Returns:
BOOL
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

- TRUE if there is a packet, FALSE otherwise.

MAC LAYER

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacket

BOOL MAC_OutputQueueDequeuePacket (Node* node, int interfaceIndex, Message** msg, MacHWAddress* nextHopAddress, int networkType, TosType * priority) Parameters:

To remove packet from front of output queue

node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - Pointer to Mac address

nextHopAddress networkType priority

- network type

- Pointer to queuing priority type

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacket

BOOL MAC_OutputQueueDequeuePacket (Node* node, int interfaceIndex, Message** msg, Mac802Address* nextHopAddress, int networkType, TosType * priority) Parameters:

To remove packet from front of output queue, Its a overloaded function

node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - Pointer to MacAddress address

nextHopAddress networkType priority

- network type

- Pointer to queuing priority type

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacket

To remove packet(s) from front of output queue; process packets

BOOL MAC_OutputQueueDequeuePacket (Node* node, int interfaceIndex, Message** msg, NodeAddress* nextHopAddress, int* networkType, TosType * priority, MacOutputQueueDequeueOption dequeueOption, MacOutputQueueDequeueCriteria dequeueCriteria, int * numFreeByte, int* numPacketPacked, TraceProtocolType tracePrt, BOOL eachWithMacHeader, int maxHeaderSize, BOOL returnPackedMsg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

with options for example, pakcing multiple packets with same next hop address together

Parameters:
node

- Pointer to a network node - interfaceIndex

interfaceIndex msg

- Pointer to Message - Pointer to Node address

nextHopAddress networkType priority

- network type

- Pointer to queuing priority type - option - criteria

dequeueOption

dequeueCriteria numFreeByte

- number of bytes can be packed in 1 transmission - number of packets packed

numPacketPacked tracePrt

- Trace Protocol Type - Each msg has its own MAC header?

eachWithMacHeader maxHeaderSize

- max mac header size - return Packed msg or a list of msgs

returnPackedMsg

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

MAC_OutputQueueDequeuePacketForAPriority

To remove packet(s) from front of output queue; process packets with options for example, pakcing multiple packets with same next hop address together

BOOL MAC_OutputQueueDequeuePacketForAPriority (Node* node, int interfaceIndex, int priority, Message** msg, NodeAddress* nextHopAddress, int* networkType, MacOutputQueueDequeueOption dequeueOption, MacOutputQueueDequeueCriteria dequeueCriteria, int * numFreeByte, int* numPacketPacked, TraceProtocolType tracePrt, BOOL eachWithMacHeader, int maxHeaderSize, BOOL returnPackedMsg) Parameters:
node

- Pointer to a network node - interfaceIndex

interfaceIndex priority msg

- Pointer to queuing priority type

- Pointer to Message - Pointer to Node address

nextHopAddress networkType

- network type

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

dequeueOption

- option - criteria

dequeueCriteria numFreeByte

- number of bytes can be packed in 1 transmission - number of packets packed

numPacketPacked tracePrt

- Trace Protocol Type - Each msg has its own MAC header?

eachWithMacHeader maxHeaderSize

- max mac header size - return Packed msg or a list of msgs

returnPackedMsg

Returns:
BOOL

- TRUE if dequeued successfully, FALSE otherwise.

- Pointer to a network node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

interfaceIndex

- interfaceIndex

Returns:
BOOL

- boolean

MAC_IsASwitch

BOOL MAC_IsASwitch (Node* node) Parameters:

To check if a node is a switch

node

- Pointer to a network node

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

NodeAddress

- Node Address

MAC_IsMyHWAddress

BOOL MAC_IsMyHWAddress (Node* node, int interfaceIndex, MacAddress* macAddr) Parameters:

Checks for own MAC address.

node

- Node pointer - Interface index

interfaceIndex macAddr

- Mac Address

Returns:
BOOL

- None

MacValidateAndSetHWAddress

void MacValidateAndSetHWAddress (char* macAddrStr, MacHWAddress* macAddr) Parameters:

Validate MAC Address String after fetching from user

macAddrStr macAddr

- Pointer to address string

- Pointer to hardware address structure

Returns:
void

- NULL

DefaultMacHWAddressToIpv4Address

NodeAddress DefaultMacHWAddressToIpv4Address (Node* node, MacHWAddress* macAddr) Parameters:

Retrieve the IP Address from Default HW Address . Default HW address is equal to 6 bytes

node

- Pointer to Node structure - Pointer to hardware address structure

macAddr

Returns:
NodeAddress

- Ip address

MacGetHardwareLength

void MacGetHardwareLength (Node* node, int interface, unsigned short hwLength) Parameters:

Retrieve the Hardware Length.

node

- Pointer to Node structure - interface whose hardware length required

interface hwLength

- Pointer to hardware string

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

MacGetHardwareType

void MacGetHardwareType (Node* node, int interface, unsigned short* type) Parameters:

Retrieve the Hardware Type.

node

- Pointer to Node structure - interface whose mac type requires

interface type

- Pointer to hardware type

Returns:
void

- NULL

MacGetHardwareAddressString

void MacGetHardwareAddressString (Node* node, int interface) Parameters:

Retrieve the Hardware Address String.

node

- Pointer to Node structure - interface whose hardware address retrieved

interface

Returns:
void

- NULL

MacAddNewInterface

void MacAddNewInterface (Node* node, NodeAddress interfaceAddress, int numHostBits, int* interfaceIndex, const NodeInput nodeInput, char* macProtocolName) Parameters:

To add a new Interface at MAC

node

- Pointer to a network node - interface IP add

interfaceAddress numHostBits

- No of host bits - interface index

interfaceIndex nodeInput

- node input - Mac protocol of interface

macProtocolName

Returns:
void

- None

MacAddVlanInfoForThisInterface

void MacAddVlanInfoForThisInterface (Node* node, int* interfaceIndex, NodeAddress interfaceAddress, const NodeInput nodeInput) Parameters:

Init and read VLAN configuration from user input for node and interface passed as arguments

node

- Pointer to a network node - interface index

interfaceIndex
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

interfaceAddress nodeInput

- interface IP add

- node input

Returns:
void

- None

MacReleaseVlanInfoForThisInterface

NodeAddress MacReleaseVlanInfoForThisInterface (Node* node, int interfaceIndex) Parameters:

To flush VLAN info for an interface

node

- Pointer to a network node - interface index

interfaceIndex

Returns:
NodeAddress

- Node Address

MAC_IsBroadcastHWAddress

BOOL MAC_IsBroadcastHWAddress (MacHWAddress* macAddr) Parameters:

Checks Broadcast MAC address

macAddr

- structure to hardware address

Returns:
BOOL

- TRUE or FALSE

MAC_IsIdenticalHWAddress

BOOL MAC_IsIdenticalHWAddress (MacHWAddress* macAddr1, MacHWAddress* macAddr2) Parameters:

Compares two MAC addresses

macAddr1 macAddr2

- Pointer to harware address structure - Pointer to harware address structure

Returns:
BOOL

- TRUE or FALSE

MAC_PrintHWAddr

void MAC_PrintHWAddr (MacHWAddress* macAddr) Parameters:

- Node pointer - Interface index

interfaceIndex

Returns:
void

- NULL

MAC_GetPacketsPriority

TosType MAC_GetPacketsPriority (Message* msg) Parameters:

Returns the priority of the packet

msg

- Node Pointer

Returns:
TosType

- priority NOTE: DOT11e updates

MAC_TranslateMulticatIPv4AddressToMulticastMacAddress

void MAC_TranslateMulticatIPv4AddressToMulticastMacAddress (NodeAddress multcastAddress, MacHWAddress* macMulticast) Parameters:

Convert the Multicast ip address to multicast MAC address

multcastAddress macMulticast

- Multicast ip address

- Pointer to mac hardware address

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

void

- NULL

MAC_OutputQueuePeekByIndex

BOOL MAC_OutputQueuePeekByIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress nextHopAddress, TosType priority) Parameters:

Look at the packet at the index of the output queue.

node

- Node pointer - Interface index

interfaceIndex msgIndex msg

- Message index

- Double pointer to message - Next hop mac address

nextHopAddress priority

- priority

Returns:
BOOL

- TRUE if the messeage found, FALSE otherwise

MAC_OutputQueuePeekByIndex

BOOL MAC_OutputQueuePeekByIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, Mac802Address* nextHopAddress, TosType priority) Parameters:

Look at the packet at the index of the output queue.

node

- Node pointer - Interface index

interfaceIndex msgIndex msg

- Message index

- Double pointer to message - Next hop mac address

nextHopAddress priority

- priority

Returns:
BOOL

- TRUE if the messeage found, FALSE otherwise

MAC_OutputQueuePeekByIndex

BOOL MAC_OutputQueuePeekByIndex (int interfaceIndex, int msgIndex, Message** msg, MacHWAddress* nextHopAddress, TosType priority) Parameters:

Look at the packet at the index of the output queue.

interfaceIndex msgIndex msg

- Interface index

- Message index

- Double pointer to message

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

nextHopAddress priority

- Next hop mac address

- priority

Returns:
BOOL

- TRUE if the messeage found, FALSE otherwise

MAC_OutputQueueDequeuePacketWithIndex

BOOL MAC_OutputQueueDequeuePacketWithIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, NodeAddress nextHopAddress, int networkType) Parameters:

To remove the packet at specified index output queue.

node

- Node pointer - Interface index

interfaceIndex msgIndex msg

- Message index

- Double pointer to message - Next hop IP address

nextHopAddress networkType

- Type of network

Returns:
BOOL

- TRUE if the messeage dequeued properly, FALSE otherwise

MAC_OutputQueueDequeuePacketWithIndex

BOOL MAC_OutputQueueDequeuePacketWithIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, Mac802Address* nextHopMacAddress, int networkType) Parameters:

To remove the packet at specified index output queue.

node

- Node pointer - Interface index

interfaceIndex msgIndex msg

- Message index

- Double pointer to message - Next hop mac address

nextHopMacAddress networkType

- Type of network

Returns:
BOOL

- TRUE if the messeage dequeued properly, FALSE otherwise

MAC_OutputQueueDequeuePacketWithIndex

BOOL MAC_OutputQueueDequeuePacketWithIndex (Node* node, int interfaceIndex, int msgIndex, Message** msg, MacHWAddress nextHopMacAddress, int networkType) Parameters:

To remove the packet at specified index output queue.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

node

- Node pointer - Interface index

interfaceIndex msgIndex msg

- Message index

- Double pointer to message - Next hop mac address

nextHopMacAddress networkType

- Type of network

Returns:
BOOL

- TRUE if the messeage dequeued properly, FALSE otherwise

MAC_IPv4addressIsMulticastAddress

BOOL MAC_IPv4addressIsMulticastAddress (NodeAddress ipV4) Parameters:

Check the given address is Multicast address or not.

ipV4

- ipV4 address

Returns:
BOOL

- TRUE or FALSE

MAC_IsBroadcastMacAddress

BOOL MAC_IsBroadcastMacAddress (MacAddress* macAddr) Parameters:

Checks Broadcast MAC address.

macAddr

- Mac Address.

Returns:
BOOL

- None

IPv4AddressToDefaultMac802Address

void IPv4AddressToDefaultMac802Address (Node* node, int index, NodeAddress ipv4Address, Mac802Address* macAddr) Parameters:

Retrieve the Mac802Address from IP address.

node

- Pointer to Node structure - Interface Index - Ipv4 address from which the

index

ipv4Address macAddr

- Pointer to Mac802address structure

Returns:
void

- NULL

ConvertVariableHWAddressTo802Address

Bool ConvertVariableHWAddressTo802Address (Node* node, MacHWAddress* macHWAddr, Mac802Address* mac802Addr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Parameters: Convert Variable Hardware address to Mac 802 addtess

node

- Pointer to Node structure - Pointer to hardware address structure - Pointer to mac 802 address structure

macHWAddr

mac802Addr

Returns:
Bool

- None

MAC_CopyMacHWAddress

void MAC_CopyMacHWAddress (MacHWAddress* destAddr, MacHWAddress* srcAddr) Parameters:

Copies Hardware address address

destAddr srcAddr

- structure to destination hardware address

- structure to source hardware address

Returns:
void

- NULL

DefaultMac802AddressToIpv4Address

NodeAddress DefaultMac802AddressToIpv4Address (Node* node, Mac802Address* macAddr) Parameters:

Retrieve IP address from.Mac802Address

node

- Pointer to Node structure - Pointer to hardware address structure

macAddr

Returns:
NodeAddress

- Ipv4 Address

IPv4AddressToHWAddress

BOOL IPv4AddressToHWAddress (Node* node, int interfaceIndex, Message* msg, NodeAddress ipv4Address) Parameters:

Converts IP address.To MacHWAddress

node

- Pointer to Node structure - interfcae index of a node

interfaceIndex msg

- Message pointer - Ipv4 address from which the

ipv4Address

Returns:
BOOL

- Returns False when conversion fails

MacHWAddressToIpv4Address

NodeAddress MacHWAddressToIpv4Address (Node * node, int interfaceIndex, MacHWAddress* macAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Parameters: This functions converts variable length Mac address to IPv4 address It checks the type of hardware address and based on that conversion is done.
node

- Pointer to node which indicates the host - Interface index of a node

interfaceIndex macAddr

- Pointer to MacHWAddress Structure.

Returns:
NodeAddress

- IP address

decToHex

char* decToHex (int dec) Parameters:

Convert one byte decimal number to hex number.

dec

- decimal number

Returns:
char*

- return correspondig hex digit string for one byte decimal number

MAC_FourByteMacAddressToVariableHWAddress

void MAC_FourByteMacAddressToVariableHWAddress (Node * node, int interfaceIndex, MacHWAddress * macAddr, NodeAddress nodeAddr) Parameters:
node

- Pointer to node which indicates the host - Interface index of a node

interfaceIndex macAddr

- Pointer to source MacHWAddress Structure - Ip address

nodeAddr

Returns:
void

- None

MAC_VariableHWAddressToFourByteMacAddress

NodeAddress MAC_VariableHWAddressToFourByteMacAddress (Node* node, MacHWAddress* macAddr) Parameters:

Retrieve IP address from.MacHWAddress of type IPV4_LINKADDRESS

node

- Pointer to Node structure - Pointer to hardware address structure

macAddr

Returns:
NodeAddress

- Ipv4 Address

GetBroadCastAddress

MacHWAddress GetBroadCastAddress (Node* node, int interfaceIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

Parameters: Returns Broadcast Address of an interface

node

- Pointer to a node - Mac Address of a node

macAddr

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAC LAYER

int

- interfaceIndex of node

MAC_Reset

void MAC_Reset (Node* node, int InterfaceIndex) Parameters:

Reset the Mac protocols use by the node

node

- Pointer to the node - interface index

InterfaceIndex

Returns:
void

- None

MAC_AddResetFunctionList

void MAC_AddResetFunctionList (Node* node, int InterfaceIndex, void* param) Parameters:

Add which protocols in the Mac layer to be reset to a fuction list pointer.

node

- Pointer to the node - interface index

InterfaceIndex param

- pointer to the protocols reset function

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

Copyright 2001-2011 Scalable Network Technologies, Inc. All rights reserved.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAC LAYER.html[5/24/2011 12:35:45 PM]

MAIN

EXata 2.2 API Specification

MAIN
This file contains some common definitions. Constant / Data Structure Summary Type
CONSTANT

Name
MAX_NUM_PHYS

Maximum number of Physical channel

CONSTANT MAX_NUM_INTERFACES

Maximum number of Interfaces.

CONSTANT PROTOCOL_TYPE_IP

Length Field value for protocol IP TYPE

CONSTANT PROTOCOL_TYPE_ARP

ARP type
CONSTANT ANY_DEST

This is a special addresses used in the MAC and network layers. It defines any destination.
CONSTANT ANY_MAC802

This is a special addresses used in the MAC and network layers. It defines any destination of six byte.
CONSTANT INVALID_802ADDRESS

This is a special addresses used in the MAC and network layers. It is used for invalid address
CONSTANT ANY_SOURCE_ADDR

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

This is a special addresses used in the MAC and network layers. It defines any source.
CONSTANT ANY_IP

This is a special addresses used in the MAC and network layers. It defines any IP.
CONSTANT ANY_INTERFACE

This is a special addresses used in the MAC and network layers. It defines any Interface.
CONSTANT CPU_INTERFACE

This is a special addresses used in the MAC and network layers. It defines CPU Interface.
CONSTANT INVALID_ADDRESS

It defines Invalid Address. Used only by mac/mac_802_11.c.

CONSTANT MAX_STRING_LENGTH

Generic maximum length of a string. The maximum length of any line in the input file is 3x this value.
CONSTANT BIG_STRING_LENGTH

maximum length of a string.

CONSTANT MAX_CLOCK_STRING_LENGTH

Generic maximum length of a clock string.

CONSTANT MAX_NW_PKT_SIZE

Defines the Maximum Network Packet Size which can handled by the physical network. In QualNet, its value is 2048. Packet larger than this will be fragmented by IP.
ENUMERATION NetworkType

Enlisted different network type

ENUMERATION

enum for the various layers in QualNet. New layers added to the simulation should be added here as well. Used by models at all layers in the protocol stack to mark newly created messages to be destined to the right layer/module.
STRUCT in6_addr

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

Describes the IPv6 address

STRUCT AtmAddress

Describes the ATM address

STRUCT Address

Describes the address structure which contains the interface address and network type

Function / Macro Summary Return Type

MACRO

Summary
MAX(X, Y)

Utility function MAX. Calculates the Maximum one from two given numbers.
MACRO MIN(X, Y)

Utility function MIN. Calculates the Minimum one from two given numbers.
MACRO ABS(X)

Utility function ABS. Return the absolute value of a given number.

MACRO IN_DB(x)

Utility function, decibel converter. Performs the 10 base log operation on the given number and then multiply with 10.
MACRO NON_DB(x)

Utility function, decibel converter. Performs power operation on the given number.
MACRO MEM_malloc

Adds filename and line number parameters to the MEM_malloc function

NodeAddress GetIPv4Address(Address addr)

Get IPv4 address from generic address

in6_addr GetIPv6Address(Address addr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

Get IPv6 address from generic address

void SetIPv4AddressInfo(Address address, NodeAddress addr)

Set IPv4 address and network type to generic address

void SetIPv6AddressInfo(Address address, in6_addr addr)

Set IPv6 address and network type to generic address

ARP type ANY_DEST 0xffffffff

This is a special addresses used in the MAC and network layers. It defines any destination.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

Constant

ANY_MAC802 0xffffffffffff

Constant

This is a special addresses used in the MAC and network layers. It defines any destination of six byte. INVALID_802ADDRESS 0xfffffffffffe

Constant

This is a special addresses used in the MAC and network layers. It is used for invalid address ANY_SOURCE_ADDR 0xffffffff

Constant

This is a special addresses used in the MAC and network layers. It defines any source. ANY_IP 0xffffffff

Constant

This is a special addresses used in the MAC and network layers. It defines any IP. ANY_INTERFACE -1

Constant

This is a special addresses used in the MAC and network layers. It defines any Interface. CPU_INTERFACE -2

Constant

This is a special addresses used in the MAC and network layers. It defines CPU Interface. INVALID_ADDRESS 987654321

Constant

It defines Invalid Address. Used only by mac/mac_802_11.c. MAX_STRING_LENGTH 200

Constant

Generic maximum length of a string. The maximum length of any line in the input file is 3x this value. BIG_STRING_LENGTH 512

Constant

maximum length of a string. MAX_CLOCK_STRING_LENGTH 24

Constant

Generic maximum length of a clock string. MAX_NW_PKT_SIZE 2048

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

Enumeration

Defines the Maximum Network Packet Size which can handled by the physical network. In QualNet, its value is 2048. Packet larger than this will be fragmented by IP. NetworkType

Enlisted different network type Enumeration enum for the various layers in QualNet. New layers added to the simulation should be added here as well. Used by models at all layers in the protocol stack to mark newly created messages to be destined to the right layer/module. in6_addr

Structure

Describes the IPv6 address AtmAddress

Structure

Describes the ATM address Address

Describes the address structure which contains the interface address and network type

Function / Macro Detail Function / Macro MAX(X, Y) Format Utility function MAX. Calculates the Maximum one from two given numbers.

MIN(X, Y)

Utility function MIN. Calculates the Minimum one from two given numbers.

ABS(X)

Utility function ABS. Return the absolute value of a given number.

IN_DB(x)

Utility function, decibel converter. Performs the 10 base log operation on the given number and then multiply with 10.

NON_DB(x)

Utility function, decibel converter. Performs power operation on the given number.

MEM_malloc

Adds filename and line number parameters to the MEM_malloc function

- IPv4 interface address.

Returns:
void

- NULL

SetIPv6AddressInfo

void SetIPv6AddressInfo (Address address, in6_addr addr) Parameters:

Set IPv6 address and network type to generic address

address addr

- generic address.

- IPv6 interface address.

Returns:
void

- NULL

RoundToInt

int RoundToInt (double x) Parameters:

Round a float point number to an integer. This function tries to get consistent value on different platforms

- The float point number to be rounded

Returns:
int

- Returns the rounded integer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

MEM_malloc

void* MEM_malloc (size_t size, char* filename, int lineno) Parameters:

Allocates memory block of a given size.

size

- Size of the memory block to be allocated. - Name of file allocating the memory

filename lineno

- Line in the file where the API is called

Returns:
void*

- Returns the pointer of allocated memory otherwise NULL if allocation fails.

MEM_free

void MEM_free (void* ptr) Parameters:

Deallocates the memory in turn it calls free().

ptr

- Pointer of memory to be freed.

Returns:
void

- None

maskChar

UInt8 maskChar (UInt8 sposition, UInt8 eposition) Parameters:

Return 1's in all bit positions between sposition and eposition

sposition eposition

- starting bit position - last bit position set to 1

Returns:
UInt8

- None

maskShort

UInt16 maskShort (UInt16 sposition, UInt16 eposition) Parameters:

Return 1's in all bit positions between sposition and eposition

sposition eposition

- starting bit position - last bit position set to 1

Returns:
UInt16

- None

maskInt

UInt32 maskInt (int sposition, int eposition) Parameters:

Return 1's in all bit positions between sposition and eposition

sposition eposition

- starting bit position

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

eposition

Returns:
UInt8

- None

RshiftShort

UInt16 RshiftShort (UInt16 x, UInt16 eposition)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAIN

Parameters: Right shifts data where eposition determines the position of thelast bit after the shift and (size-eposition) determines the number of bits to be shifted
x

- the data to be shifted - last bit position set to 1

eposition

Returns:
UInt16

- None

RshiftInt

UInt32 RshiftInt (UInt32 x, int eposition) Parameters:

Right shifts data where eposition determines the position of thelast bit after the shift and (size-eposition) determines the number of bits to be shifted

- the data to be shifted - last bit position set to 1

eposition

Returns:
UInt32

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAIN.html[5/24/2011 12:36:07 PM]

MAPPING

EXata 2.2 API Specification

MAPPING
This file describes data structures and functions for mapping between node pointers, node identifiers, and node addresses. Constant / Data Structure Summary Type
CONSTANT

Name
INVALID_MAPPING

Indicates Invalid Mapping

CONSTANT MAX_INTERFACE_ADDRESSES

max no of addressees assigned to an interface

CONSTANT NODE_HASH_SIZE

Defines node hash size. Hashes the nodeIds using a mod NODE_HASH_SIZE hash.
STRUCT NetworkProperty

Describes the property of a network.

STRUCT AddressMappingType

Describes the type of address mapping.

STRUCT AddressReverseMappingType

Describes the type of reverse address mapping.

STRUCT SubnetListType

Used to determine what the next address counter should be for each subnet address. This is needed to allow different SUBNET/LINK statements to declare the same subnet address.
STRUCT AddressMapType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Describes the detailed information of Node ID <--> IP address mappings.

STRUCT nodeIdToNodePtr

Describes the nodeId and corresponding nodePtr.

Function / Macro Summary Return Type

MACRO

Summary
MADDR6_SCOPE(a)

Multicast Address Scope.

MACRO IS_MULTIADDR6(a)

Checks whether an address is multicast address.

MACRO CLR_ADDR6(a)

Set an address with 0 values.

MACRO IS_CLR_ADDR6(a)

Does an address have the value of 0 (Cleared).

MACRO COPY_ADDR6(from, to)

Copies from-ipv6 address to to-ipv6 address.

MACRO SAME_ADDR6(a, b)

Checks if a and b address is same address.

MACRO IS_ANYADDR6(a)

Checks whether the address is any address or not.

MACRO IS_LOOPADDR6(a)

Checks whether it is loopback address.

MACRO CMP_ADDR6(a, b)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Compaires two addresses.

MACRO IS_IPV4ADDR6(a)

Checks whether it is ipv4 address.

MACRO IS_LOCALADDR6(a)

Checks whether it is local address.

MACRO IS_LINKLADDR6(a)

Checks whether it is link local address.

MACRO IS_SITELADDR6(a)

Checks whether it is site local address.

MACRO SAME_ADDR4(a, b)

Checks whether IPv4 addresses match.

MACRO IS_ANYADDR4(a)

Checks whether IPv4 address is ANY_DEST.

BOOL Address_IsSameAddress(Address* addr1 addr1, Address* addr2 addr2)

Check whether both addresses(i.e. addr1 and addr2) are same.

BOOL Address_IsAnyAddress(Address* addr addr)

Check whether addr is any address of the same type

BOOL Address_IsMulticastAddress(Address* addr addr)

Check whether addr is a multicast address

BOOL Address_IsSubnetBroadcastAddress(Node* node node, Address* addr addr)

Check whether addr is a subnet broadcast address

void Address_SetToAnyAddress(Address* addr addr, Address* refAddr refAddr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Set addr to any address of the same type as refAddr.

void Address_AddressCoopy(Address* dstAddress, Address* srcAddress)

Copy srcAddress to dstAddress

int Ipv6CompareAddr6(in6_addr a, in6_addr b)

Compairs to ipv6 address. if a is greater than b then returns positive, if equals then 0, a is smaller then b then negative.
BOOL Ipv6IsAddressInNetwork(const in6_addr* globalAddr, unsigned int tla, unsigned int vla, unsigned int sla)

Checks whether the address is in the same network. : if in the same network then returns TRUE, otherwise FALSE.
BOOL Ipv6IsAddressInNetwork(const in6_addr* globalAddr, const in6_addr* ipv6SubnetAddr, unsigned int prefixLenth)

Checks whether the address is in the same network. : if in the same network then returns TRUE, otherwise FALSE.
BOOL Ipv6CheckNetworkParams(unsigned int tla tla, unsigned int nla nla, unsigned int sla sla)

Checks network parameters (tla, nla, sla)

void MAPPING_HashNodeId(IdToNodePtrMap* hash, NodeAddress nodeId, Node* nodePtr)

Hashes the nodeIds using a mod NODE_HASH_SIZE hash. This is not thread safe.
Node* MAPPING_GetNodePtrFromHash(IdToNodePtrMap* hash, NodeAddress nodeId)

Retrieves the node pointer for nodeId from hash.

AddressMapType* MAPPING_MallocAddressMap()

Allocates memory block of size AddressMapType.

void MAPPING_InitAddressMap(AddressMapType* map)

Initializes the AddressMapType structure.

void MAPPING_BuildAddressMap(const NodeInput* nodeInput, NodeAddress** nodeIdArrayPtr, AddressMapType* map)

Builds the address map

NodeAddress MAPPING_GetInterfaceAddressForSubnet(Node* node, NodeAddress nodeId, NodeAddress subnetAddress, int numHostBits)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Gives Interface address for a Subnet.

NodeAddress MAPPING_GetInterfaceAddressForSubnet(const AddressMapType* map, NodeAddress nodeId, NodeAddress subnetAddress, int numHostBits)

Gives Interface address for a Subnet.

NodeAddress MAPPING_GetSubnetAddressForInterface(Node* node, NodeAddress nodeId, int interfaceIndex)

Gives the Subnet address for an interface.

NodeAddress MAPPING_GetSubnetMaskForInterface(Node* node, NodeAddress nodeId, int interfaceIndex)

Gives the Subnet mask for an interface.

int MAPPING_GetNumHostBitsForInterface(Node* node, NodeAddress nodeId, int interfaceIndex)

Gives the number of host bits for an interface.

void MAPPING_GetInterfaceInfoForInterface(Node* node, NodeAddress nodeId, int interfaceIndex, NodeAddress* interfaceAddress, NodeAddress* subnetAddress, NodeAddress* subnetMask, int* numHostBits)

Gives the Interface information for an interface.

NodeAddress MAPPING_GetInterfaceAddressForInterface(Node* node, NodeAddress nodeId, int interfaceIndex)

Gives the Interface address for an interface.

Address MAPPING_GetInterfaceAddressForInterface(NetworkType netType, int relativeInfInx)

Get node interface Address according to the network specific interface index. Overloaded function for ATM compatibility.
NodeAddress MAPPING_GetNodeIdFromInterfaceAddress(Node* node, NodeAddress interfaceAddress)

Gives Node id from an interface address.

NodeAddress MAPPING_GetNodeIdFromInterfaceAddress(Node* node, Address interfaceAddress)

Gives Node id from an interface address. Overloaded for IPv6

NodeAddress MAPPING_GetDefaultInterfaceAddressFromNodeId(Node* node, NodeAddress nodeId)

Gives default interface address from a node id.

unsigned int MAPPING_GetNumNodesInSubnet(Node* node, NodeAddress subnetAddress)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Gives the number of nodes in a subnet.

unsigned int MAPPING_GetSubnetAddressCounter(AddressMapType* map, NodeAddress subnetAddress)

Gives the subnet address counter.

void MAPPING_UpdateSubnetAddressCounter(AddressMapType* map, NodeAddress subnetAddress, int addressCounter)

Updates the subnet address counter.

int MAPPING_GetInterfaceIndexFromInterfaceAddress(Node* node, NodeAddress interfaceAddress)

Gets the node's interface index for the given address.

Address MAPPING_GetNodeInfoFromAtmNetInfo(unsigned int* index, unsigned int* genIndex)

Get node interface Address, generic interfaceIndex and Atm related interfaceIndex from ATM Network information.
unsigned int MAPPING_GetInterfaceIdForDestAddress(Node* node, NodeId nodeId, NodeAddress destAddr)

For a given destination address find its interface index

NodeAddress MAPPING_GetSubnetMaskForDestAddress(Node* node, NodeId nodeId, NodeAddress destAddr)

For a given nodeId & destination address find the subnet mask for the associated network
NodeAddress MAPPING_GetInterfaceAddrForNodeIdAndIntfId(Node* node, NodeId nodeId, int intfId)

For a given nodeId & InterfaceId find the associated IP-Address

unsigned int MAPPING_GetIPv6NetworkAddressCounter(AddressMapType* map, in6_addr subnetAddr, unsigned int subnetPrefixLen)

Get IPV6 network address counter.

void MAPPING_UpdateIPv6NetworkAddressCounter(AddressMapType* map, in6_addr subnetAddr, unsigned int subnetPrefixLen, int addressCounter)

Update IPV6 network address counter.

unsigned int MAPPING_GetNumNodesInIPv6Network(Node* node, in6_addr subnetAddr, unsigned int subnetPrefixLen)

Get Num of nodes in IPV6 network.

NetworkType MAPPING_GetNetworkIPVersion(const char* addrString)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Get Network version IPv4/IPv6.

NetworkType MAPPING_GetNetworkType(const char* addrString)

Identify network type from addrString.

void MAPPING_GetIpv6InterfaceInfoForInterface(Node *node node, NodeId nodeId nodeId, int interfaceIndex, in6_addr* globalAddr, in6_addr* subnetAddr, unsigned int* subnetPrefixLen)

Get IPV6 interface information for a interface.

BOOL MAPPING_GetIpv6GlobalAddress(Node *node node, NodeId nodeId nodeId, unsigned int tla, unsigned int nla, unsigned int sla, in6_addr * addr6)

Get IPV6 global address.

BOOL MAPPING_GetIpv6GlobalAddressForInterface(Node * node, NodeId nodeId, int interfaceIndex, in6_addr * addr6, BOOL isDeprecated)

Get IPV6 global address for a node's nth interface.

void MAPPING_CreateIpv6GlobalUnicastAddr(unsigned int tla, unsigned int nla, unsigned int sla, int addressCounter, in6_addr* globalAddr)

Create IPv6 Global Unicast Address from tla nla sla

void MAPPING_CreateIpv6GlobalUnicastAddr(AddressMapType * map, in6_addr IPv6subnetAddress, uunsigned int IPv6subnetPrefixLen, int addressCounter, in6_addr* globalAddr)

Create IPv6 Global Unicast Address.

void MAPPING_CreateIpv6LinkLocalAddr(in6_addr* globalAddr, in6_addr* linkLocalAddr, unsigned int subnetPrefixLen)

Create IPv6 link local Address.

void MAPPING_CreateIpv6SiteLocalAddr(in6_addr* globalAddr, in6_addr* siteLocalAddr, unsigned short siteCounter, unsigned int subnetPrefixLen)

Create IPv6 site local Address.

void MAPPING_CreateIpv6MulticastAddr(in6_addr* globalAddr, in6_addr* multicastAddr)

Create ipv6 multicast address.

void MAPPING_CreateIpv6SubnetAddr(unsigned int tla, unsigned int nla, unsigned int sla, unsigned int* IPv6subnetPrefixLen, in6_addr* IPv6subnetAddress)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

create subnet addr for IPV6 address.

NodeId MAPPING_GetNodeIdFromGlobalAddr(Node * node, in6_addr* globalAddr)

Get node id from Global Address.

NodeId MAPPING_GetNodeIdFromLinkLayerAddr(Node * node, NodeAddress linkLayerAddr)

Get node id from Link layer Address.

NodeAddress MAPPING_CreateIpv6LinkLayerAddr(unsigned int nodeId, int interfaceId)

Create IPv6 link layer Address.

BOOL MAPPING_IsIpv6AddressOfThisNode(Node* node, const NodeAddress nodeId, in6_addr* globalAddr)

checks whether the ipv6 address is of this node.

BOOL MAPPING_IsNodeInThisIpRange(Node* node, NodeId nodeId, NodeAddress startRange, NodeAddress endRange)

checks whether the node is in given range of : Addresses.

BOOL MAPPING_IsIpAddressOfThisNode(Node* node, const NodeAddress nodeId, NodeAddress addr)

checks whether the ipv4 address is of this node.

BOOL MAPPING_GetInterfaceAddressForSubnet(Node* node, NodeId nodeId, in6_addr* ipv6SubnetAddr, unsigned int prefixLenth, in6_addr* ipv6InterfaceAddr, int* interfaceIndex)

Get interface address for subnet using ipv6 addr.

BOOL MAPPING_GetInterfaceAddressForSubnet(const AddressMapType* map, NodeId nodeId, in6_addr* ipv6SubnetAddr, unsigned int prefixLenth, in6_addr* ipv6InterfaceAddr, int* interfaceIndex)

Get interface address for subnet using ipv6 addr.

BOOL MAPPING_GetInterfaceAddressForSubnet(Node* node node, NodeId nodeId nodeId, unsigned int tla, unsigned int nla, unsigned int sla, in6_addr* ipv6Addr, int* interfaceIndex)

Get interface address for subnet using tla nla sla.

BOOL ; MAPPING_GetInterfaceAddressForSubnet(const AddressMapType* map, NodeId nodeId, unsigned int tla, unsigned int nla, unsigned int sla, in6_addr* ipv6Addr, int* interfaceIndex)

Get interface address for subnet using tla nla sla.

int MAPPING_GetInterfaceFromLinkLayerAddress(Node* node, const NodeAddress linkLayerAddr)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Get interface from link layer address.

int MAPPING_GetInterfaceIndexFromInterfaceAddress(Node* node, Address interfaceAddress)

Get interface index from interface address.

BOOL MAPPING_GetIpv6GlobalAddress(Node* node, NodeId nodeId, in6_addr subnetAddr, UInt32 prefixLen, in6_addr* addr6)

Get ipv6 global address

Address MAPPING_GetDefaultInterfaceAddressInfoFromNodeId(Node *node node, NodeAddress nodeId nodeId, NetworkType networktype networktype)

Get default interface address based on network type

void Mapping_AutoCreateIPv6SubnetAddress(NodeAddress ipAddress, subnetString)

Create IPv6 Testing Address Prefix (RFC 2471)from : ipv4 address.

NodeAddress MAPPING_GetSubnetAddressFromInterfaceAddress(Node *node node, NodeAddress interfaceAddress)

Get subnet address from interface address.

BOOL MAPPING_GetSubnetAddressFromInterfaceAddress(Node * node, in6_addr* ipv6InterfaceAddr, in6_addr* ipv6SubnetAddr)

Get ipv6 network Prefix from interface address.

BOOL MAPPING_GetPrefixLengthForInterfaceAddress(Node* node, in6_addr* ipv6InterfaceAddr, unsigned int prefixLenth)

Get prefix length for interface address.

NetworkProtocolType MAPPING_GetNetworkProtocolTypeForNode(NodeAddress nodeId, const NodeInput * nodeInput)

Get Network Protocol Type for the node.

Constant / Data Structure Detail

Constant

INVALID_MAPPING 0xffffffff

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Describes the nodeId and corresponding nodePtr.

Function / Macro Detail Function / Macro MADDR6_SCOPE(a) Format Multicast Address Scope.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

IS_MULTIADDR6(a)

Checks whether an address is multicast address.

CLR_ADDR6(a)

Set an address with 0 values.

IS_CLR_ADDR6(a)

Does an address have the value of 0 (Cleared).

COPY_ADDR6(from, to)

Copies from-ipv6 address to to-ipv6 address.

SAME_ADDR6(a, b)

Checks if a and b address is same address.

IS_ANYADDR6(a)

Checks whether the address is any address or not.

IS_LOOPADDR6(a)

Checks whether it is loopback address.

CMP_ADDR6(a, b)

Compaires two addresses.

IS_IPV4ADDR6(a)

Checks whether it is ipv4 address.

IS_LOCALADDR6(a)

Checks whether it is local address.

IS_LINKLADDR6(a)

Checks whether it is link local address.

IS_SITELADDR6(a)

Checks whether it is site local address.

SAME_ADDR4(a, b)

Checks whether IPv4 addresses match.

IS_ANYADDR4(a)

Checks whether IPv4 address is ANY_DEST.

Address_IsSameAddress

BOOL Address_IsSameAddress (Address* addr1 addr1, Address* addr2 addr2) Parameters:

Check whether both addresses(i.e. addr1 and addr2) are same.

addr1 addr2

Set addr to any address of the same type as refAddr.

addr

- Pointer to address - Pointer to refAddr

Ipv6IsAddressInNetwork

BOOL Ipv6IsAddressInNetwork (const in6_addr* globalAddr, const in6_addr* ipv6SubnetAddr, unsigned int prefixLenth) Parameters:

Checks whether the address is in the same network. : if in the same network then returns TRUE, otherwise FALSE.

globalAddr

- Pointer to ipv6 address. - Pointer to ipv6 subnet address.

ipv6SubnetAddr prefixLenth

- prefix length of the address.

Returns:
BOOL

- TRUE if the address is in the same network, FALSE otherwise

Ipv6CheckNetworkParams

BOOL Ipv6CheckNetworkParams (unsigned int tla tla, unsigned int nla nla, unsigned int sla sla) Parameters:

Checks network parameters (tla, nla, sla)

tla nla sla

- Top level aggregation. - Next level aggregation. - Site level aggregaton.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Returns:
BOOL

- None

MAPPING_HashNodeId

void MAPPING_HashNodeId (IdToNodePtrMap* hash, NodeAddress nodeId, Node* nodePtr) Parameters:

Hashes the nodeIds using a mod NODE_HASH_SIZE hash. This is not thread safe.

hash

- IdToNodePtrMap pointer - Node id. - Node poniter

nodeId

nodePtr

Returns:
void

- None

MAPPING_GetNodePtrFromHash

Node* MAPPING_GetNodePtrFromHash (IdToNodePtrMap* hash, NodeAddress nodeId) Parameters:

Retrieves the node pointer for nodeId from hash.

hash

- IdToNodePtrMap pointer - Node id.

nodeId

Returns:
Node*

- Node pointer for nodeId.

MAPPING_MallocAddressMap

AddressMapType* MAPPING_MallocAddressMap () Parameters:

Allocates memory block of size AddressMapType.

Returns:
AddressMapType*

- Pointer to a new AddressMapType structure.

MAPPING_InitAddressMap

void MAPPING_InitAddressMap (AddressMapType* map) Parameters:

Initializes the AddressMapType structure.

map

- A pointer of type AddressMapType.

Returns:
void

- None

MAPPING_BuildAddressMap

void MAPPING_BuildAddressMap (const NodeInput* nodeInput, NodeAddress** nodeIdArrayPtr, AddressMapType* map) Parameters:

Builds the address map

nodeInput
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

- A pointer to const NodeInput.

MAPPING

nodeIdArrayPtr map

- A pointer to pointer of NodeAddress

- A pointer of type AddressMapType.

Returns:
void

- None

MAPPING_GetInterfaceAddressForSubnet

NodeAddress MAPPING_GetInterfaceAddressForSubnet (Node* node, NodeAddress nodeId, NodeAddress subnetAddress, int numHostBits) Parameters:

Gives Interface address for a Subnet.

node

- A pointer to node being initialized - Node id - Subnet address

nodeId

subnetAddress numHostBits

- Number of host bits

Returns:
NodeAddress

- Interface address for the subnet.

MAPPING_GetInterfaceAddressForSubnet

NodeAddress MAPPING_GetInterfaceAddressForSubnet (const AddressMapType* map, NodeAddress nodeId, NodeAddress subnetAddress, int numHostBits) Parameters:

Gives Interface address for a Subnet.

map

- A pointer to address map - Node id - Subnet address

nodeId

subnetAddress numHostBits

- Number of host bits

Returns:
NodeAddress

- Interface address for the subnet.

MAPPING_GetSubnetAddressForInterface

NodeAddress MAPPING_GetSubnetAddressForInterface (Node* node, NodeAddress nodeId, int interfaceIndex) Parameters:

Gives the Subnet address for an interface.

node

- A pointer to node being initialized. - Node id - Interface index

nodeId

interfaceIndex

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

NodeAddress

- Subnet address for an interface.

MAPPING_GetSubnetMaskForInterface

NodeAddress MAPPING_GetSubnetMaskForInterface (Node* node, NodeAddress nodeId, int interfaceIndex) Parameters:

Gives the Subnet mask for an interface.

node

- A pointer to node being initialized. - Node id - Interface index

nodeId

interfaceIndex

Returns:
NodeAddress

- Subnet mask for an interface.

MAPPING_GetNumHostBitsForInterface

int MAPPING_GetNumHostBitsForInterface (Node* node, NodeAddress nodeId, int interfaceIndex) Parameters:

Gives the number of host bits for an interface.

node

- A pointer to node being initialized. - Node id - Interface index

nodeId

interfaceIndex

Returns:
int

- The number of host bits for an interface.

MAPPING_GetInterfaceInfoForInterface

void MAPPING_GetInterfaceInfoForInterface (Node* node, NodeAddress nodeId, int interfaceIndex, NodeAddress* interfaceAddress, NodeAddress* subnetAddress, NodeAddress* subnetMask, int* numHostBits) Parameters:

Gives the Interface information for an interface.

node

- A pointer to node being initialized. - Node id - Interface index - Interface address, int pointer.

nodeId

interfaceIndex

interfaceAddress subnetAddress subnetMask

- Subnet address, NodeAddress pointer.

- Subnet mask, NodeAddress pointer. - Number of host bits, int pointer.

numHostBits

Returns:
void

- None

MAPPING_GetInterfaceAddressForInterface

NodeAddress MAPPING_GetInterfaceAddressForInterface (Node* node, NodeAddress nodeId, int interfaceIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Parameters: Gives the Interface address for an interface.

node

- A pointer to the node being initialized. - Node id - Interface index

nodeId

interfaceIndex

Returns:
NodeAddress

- Interface address for an interface.

MAPPING_GetInterfaceAddressForInterface

Address MAPPING_GetInterfaceAddressForInterface (NetworkType netType, int relativeInfInx) Parameters:

Get node interface Address according to the network specific interface index. Overloaded function for ATM compatibility.

netType

- Network type of the interface. - Inrerface index related to networkType.

relativeInfInx

Returns:
Address

- Return Address.

MAPPING_GetNodeIdFromInterfaceAddress

NodeAddress MAPPING_GetNodeIdFromInterfaceAddress (Node* node, NodeAddress interfaceAddress) Parameters:

Gives Node id from an interface address.

node

- A pointer to node being initialized. - Interface address

interfaceAddress

Returns:
NodeAddress

- None

MAPPING_GetNodeIdFromInterfaceAddress

NodeAddress MAPPING_GetNodeIdFromInterfaceAddress (Node* node, Address interfaceAddress) Parameters:

Gives Node id from an interface address. Overloaded for IPv6

node

- A pointer to node being initialized. - Interface address

interfaceAddress

Returns:
NodeAddress

- None

MAPPING_GetDefaultInterfaceAddressFromNodeId

NodeAddress MAPPING_GetDefaultInterfaceAddressFromNodeId (Node* node, NodeAddress nodeId) Parameters:

Gives default interface address from a node id.

node

- A pointer to node being initialized.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

nodeId

- Node id

Returns:
NodeAddress

- Default interface address from the node id.

MAPPING_GetNumNodesInSubnet

unsigned int MAPPING_GetNumNodesInSubnet (Node* node, NodeAddress subnetAddress) Parameters:

Gives the number of nodes in a subnet.

node

- A pointer to node being initialized. - Subnet address

subnetAddress

Returns:
unsigned int

- Number of nodes in a subnet.

MAPPING_GetSubnetAddressCounter

unsigned int MAPPING_GetSubnetAddressCounter (AddressMapType* map, NodeAddress subnetAddress) Parameters:

Gives the subnet address counter.

map

- A pointer to AddressMapType. - Subnet address

subnetAddress

Returns:
unsigned int

- The subnet address counter.

MAPPING_UpdateSubnetAddressCounter

void MAPPING_UpdateSubnetAddressCounter (AddressMapType* map, NodeAddress subnetAddress, int addressCounter) Parameters:

Updates the subnet address counter.

map

- A pointer to AddressMapType. - Subnet address - Address counter

subnetAddress

addressCounter

Returns:
void

- None

MAPPING_GetInterfaceIndexFromInterfaceAddress

int MAPPING_GetInterfaceIndexFromInterfaceAddress (Node* node, NodeAddress interfaceAddress) Parameters:

Gets the node's interface index for the given address.

node

- A pointer to node being initialized. - Interface address

interfaceAddress

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

int

- The interface index.

MAPPING_GetNodeInfoFromAtmNetInfo

Address MAPPING_GetNodeInfoFromAtmNetInfo (unsigned int* index, unsigned int* genIndex) Parameters:

Get node interface Address, generic interfaceIndex and Atm related interfaceIndex from ATM Network information.

index

- return atm related interface index of a - return generic interface index of a node.

genIndex

Returns:
Address

- Return valid ATM Address related to Network information if genIndex is not equal to -1.

MAPPING_GetInterfaceIdForDestAddress

unsigned int MAPPING_GetInterfaceIdForDestAddress (Node* node, NodeId nodeId, NodeAddress destAddr) Parameters:

unsigned int MAPPING_GetIPv6NetworkAddressCounter (AddressMapType* map, in6_addr subnetAddr, unsigned int subnetPrefixLen) Parameters:

Get IPV6 network address counter.

map

- The address map. - The IPv6 address. - The prefix length.

subnetAddr

subnetPrefixLen

Returns:
unsigned int

- The current counter.

MAPPING_UpdateIPv6NetworkAddressCounter

void MAPPING_UpdateIPv6NetworkAddressCounter (AddressMapType* map, in6_addr subnetAddr, unsigned int subnetPrefixLen, int addressCounter) Parameters:

Update IPV6 network address counter.

map

- The address map. - The IPv6 address. - The prefix length.

subnetAddr

subnetPrefixLen addressCounter

- The new counter value.

Returns:
void

- None

MAPPING_GetNumNodesInIPv6Network

unsigned int MAPPING_GetNumNodesInIPv6Network (Node* node, in6_addr subnetAddr, unsigned int subnetPrefixLen) Parameters:

Get Num of nodes in IPV6 network.

node

- The pointer to the node. - The IPv6 address. - The prefix length.

subnetAddr

subnetPrefixLen

Returns:
unsigned int

- None

MAPPING_GetNetworkIPVersion

NetworkType MAPPING_GetNetworkIPVersion (const char* addrString) Parameters:

Get Network version IPv4/IPv6.

addrString

- The address string

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

Returns:
NetworkType

- None

MAPPING_GetNetworkType

NetworkType MAPPING_GetNetworkType (const char* addrString) Parameters:

Identify network type from addrString.

addrString

- The address string

Returns:
NetworkType

- None

MAPPING_GetIpv6InterfaceInfoForInterface

void MAPPING_GetIpv6InterfaceInfoForInterface (Node *node node, NodeId nodeId nodeId, int interfaceIndex, in6_addr* globalAddr, in6_addr* subnetAddr, unsigned int* subnetPrefixLen) Parameters:

Get IPV6 interface information for a interface.

node

- The node. - Node Id - The interface index.

nodeId

interfaceIndex globalAddr subnetAddr

- The global IPv6 address. - The subnet IPv6 address. - THe subnet prefex length.

subnetPrefixLen

Returns:
void

- None

MAPPING_GetIpv6GlobalAddress

BOOL MAPPING_GetIpv6GlobalAddress (Node *node node, NodeId nodeId nodeId, unsigned int tla, unsigned int nla, unsigned int sla, in6_addr * addr6) Parameters:

Get IPV6 global address.

node

- The node - The node's id

nodeId tla nla sla

- Top level aggregation - Next level aggregation - Site level aggregation - The global IPv6 address.

addr6

Returns:
BOOL
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

- None

MAPPING

MAPPING_GetIpv6GlobalAddressForInterface

BOOL MAPPING_GetIpv6GlobalAddressForInterface (Node * node, NodeId nodeId, int interfaceIndex, in6_addr * addr6, BOOL isDeprecated) Parameters:

Get IPV6 global address for a node's nth interface.

node

- The node - The node's id - The interface index.

nodeId

interfaceIndex addr6

- The global IPv6 address. - Return deprecated address (if valid)

isDeprecated

Returns:
BOOL

- None

MAPPING_CreateIpv6GlobalUnicastAddr

void MAPPING_CreateIpv6GlobalUnicastAddr (unsigned int tla, unsigned int nla, unsigned int sla, int addressCounter, in6_addr* globalAddr) Parameters:

Create IPv6 Global Unicast Address from tla nla sla

tla nla sla

- Top level aggregation - Next level aggregation - Site level aggregation - The address counter.

addressCounter globalAddr

- The global IPv6 address.

Returns:
void

- None

MAPPING_CreateIpv6GlobalUnicastAddr

void MAPPING_CreateIpv6GlobalUnicastAddr (AddressMapType * map, in6_addr IPv6subnetAddress, uunsigned int IPv6subnetPrefixLen, int addressCounter, in6_addr* globalAddr) Parameters:

Create IPv6 Global Unicast Address.

map

- The address map. - The subnet address. - The prefix length.

IPv6subnetAddress

IPv6subnetPrefixLen addressCounter globalAddr

- The address counter.

- The global IPv6 address.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

void

- None

MAPPING_CreateIpv6LinkLocalAddr

void MAPPING_CreateIpv6LinkLocalAddr (in6_addr* globalAddr, in6_addr* linkLocalAddr, unsigned int subnetPrefixLen) Parameters:

Create IPv6 link local Address.

globalAddr

- The global IPv6 address. - The subnet IPv6 address. - The subnet prefix length.

linkLocalAddr

subnetPrefixLen

Returns:
void

- None

MAPPING_CreateIpv6SiteLocalAddr

void MAPPING_CreateIpv6SiteLocalAddr (in6_addr* globalAddr, in6_addr* siteLocalAddr, unsigned short siteCounter, unsigned int subnetPrefixLen) Parameters:

Create IPv6 site local Address.

globalAddr

- The global IPv6 address. - The subnet IPv6 address.

siteLocalAddr siteCounter

- The counter to use. - The subnet prefix length.

subnetPrefixLen

Returns:
void

- None

MAPPING_CreateIpv6MulticastAddr

void MAPPING_CreateIpv6MulticastAddr (in6_addr* globalAddr, in6_addr* multicastAddr) Parameters:

Create ipv6 multicast address.

globalAddr

- The global IPv6 address. - The multicast IPv6 address.

multicastAddr

Returns:
void

- None

MAPPING_CreateIpv6SubnetAddr

void MAPPING_CreateIpv6SubnetAddr (unsigned int tla, unsigned int nla, unsigned int sla, unsigned int* IPv6subnetPrefixLen, in6_addr* IPv6subnetAddress) Parameters:

create subnet addr for IPV6 address.

tla nla

- Top level aggregation. - Next level aggregation.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

sla

- Site level aggregation. - The IPv6 prefix length.

IPv6subnetPrefixLen IPv6subnetAddress

interfaceId

Returns:
NodeAddress

- None

MAPPING_IsIpv6AddressOfThisNode

BOOL MAPPING_IsIpv6AddressOfThisNode (Node* node, const NodeAddress nodeId, in6_addr* globalAddr) Parameters:

checks whether the ipv6 address is of this node.

node

- The node id. - The node's address.

nodeId

globalAddr
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

- The global IPv6 address. Returns:

BOOL

- None

MAPPING_IsNodeInThisIpRange

BOOL MAPPING_IsNodeInThisIpRange (Node* node, NodeId nodeId, NodeAddress startRange, NodeAddress endRange) Parameters:

checks whether the node is in given range of : Addresses.

node

- The node. - The node id. - The starting address.

Get interface address for subnet using tla nla sla.

node

- The node. - The node id.

nodeId tla nla sla

- Top level aggregation. - Next level aggregation. - Site level aggregation. - The ipv6 interface address. - The interface index.

ipv6Addr

interfaceIndex

Returns:
BOOL

- None

; MAPPING_GetInterfaceAddressForSubnet

BOOL ; MAPPING_GetInterfaceAddressForSubnet (const AddressMapType* map, NodeId nodeId, unsigned int tla, unsigned int nla, unsigned int sla, in6_addr* ipv6Addr, int* interfaceIndex) Parameters:

Get interface address for subnet using tla nla sla.

map

- The address map. - The node id.

nodeId
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

tla nla sla

- Top level aggregation. - Next level aggregation. - Site level aggregation. - The ipv6 interface address. - The interface index.

ipv6Addr

nodeId

subnetAddr prefixLen addr6

- The subnet prefix length.

- The IPv6 address.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

BOOL

- None

MAPPING_GetDefaultInterfaceAddressInfoFromNodeId

Address MAPPING_GetDefaultInterfaceAddressInfoFromNodeId (Node *node node, NodeAddress nodeId nodeId, NetworkType networktype networktype) Parameters:

Get default interface address based on network type

node

- The node. - The node id. - The network type.

nodeId

networktype

Returns:
Address

- None

Mapping_AutoCreateIPv6SubnetAddress

void Mapping_AutoCreateIPv6SubnetAddress (NodeAddress ipAddress, subnetString) Parameters:

Create IPv6 Testing Address Prefix (RFC 2471)from : ipv4 address.

ipAddress

- The IPv4 address. - char*

subnetString

Returns:
void

- NONE

MAPPING_GetSubnetAddressFromInterfaceAddress

NodeAddress MAPPING_GetSubnetAddressFromInterfaceAddress (Node *node node, NodeAddress interfaceAddress) Parameters:

Get subnet address from interface address.

node

- The node address. - The interface address.

interfaceAddress

Returns:
NodeAddress

- subnet address

MAPPING_GetSubnetAddressFromInterfaceAddress

BOOL MAPPING_GetSubnetAddressFromInterfaceAddress (Node * node, in6_addr* ipv6InterfaceAddr, in6_addr* ipv6SubnetAddr) Parameters:

Get ipv6 network Prefix from interface address.

node

- The node. - The IPv6 interface address.

ipv6InterfaceAddr ipv6SubnetAddr

- The subnet address pointer .

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MAPPING

BOOL

- None

MAPPING_GetPrefixLengthForInterfaceAddress

BOOL MAPPING_GetPrefixLengthForInterfaceAddress (Node* node, in6_addr* ipv6InterfaceAddr, unsigned int prefixLenth) Parameters:

Get prefix length for interface address.

node

- The node. - The IPV6 interface address.

ipv6InterfaceAddr prefixLenth

- The interface prefix length.

Returns:
BOOL

- None

MAPPING_GetNetworkProtocolTypeForNode

NetworkProtocolType MAPPING_GetNetworkProtocolTypeForNode (NodeAddress nodeId, const NodeInput * nodeInput) Parameters:

Get Network Protocol Type for the node.

nodeId

- The node id. - The node input file

nodeInput

Returns:
NetworkProtocolType

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MAPPING.html[5/24/2011 12:36:33 PM]

MEMORY

EXata 2.2 API Specification

MEMORY
This file describes the memory management data structures and functions. Constant / Data Structure Summary Type
STRUCT

Name
MemoryUsageData

Defines the parameters collected by the memory system. Restricted to kernel use.

Function / Macro Summary Return Type

void

Summary
MEM_CreateThreadData()

Creates partition-specific space for collecting memory usage statistics. This is used in threaded versions of QualNet, but not in distributed versions, currently.
void MEM_InitializeThreadData(MemoryUsageData* data)

Sets the partition-specific memory data for this partition.

void MEM_PrintThreadData()

Prints the partition-specific memory data.

void MEM_ReportPartitionUsage(int partitionId, UInt32 totalAllocatedMemory, UInt32 totalFreedMemory, UInt32 totalPeakUsage)

Prints out the total memory used by this partition.

void MEM_ReportTotalUsage(UInt32 totalAllocatedMemory, UInt32 totalFreedMemory, UInt32 totalPeakUsage)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MEMORY.html[5/24/2011 12:36:49 PM]

MEMORY

Prints out the total memory usage statistics for the simulation. In a parallel run, the peak usage is the sum of the partition's peak usage and might not be precisely accurate.

Constant / Data Structure Detail

Structure

MemoryUsageData

Defines the parameters collected by the memory system. Restricted to kernel use.

Function / Macro Detail Function / Macro MEM_CreateThreadData Format void MEM_CreateThreadData () Parameters: Creates partition-specific space for collecting memory usage statistics. This is used in threaded versions of QualNet, but not in distributed versions, currently. MEM_InitializeThreadData Returns:
void

- None

void MEM_InitializeThreadData (MemoryUsageData* data) Parameters:

Sets the partition-specific memory data for this partition.

data

- the data

Returns:
void

- None

MEM_PrintThreadData

void MEM_PrintThreadData () Parameters:

Prints the partition-specific memory data.

Returns:
void

- None

MEM_ReportPartitionUsage

void MEM_ReportPartitionUsage (int partitionId, UInt32 totalAllocatedMemory, UInt32 totalFreedMemory, UInt32 totalPeakUsage) Parameters:

Prints out the total memory used by this partition.

partitionId

- the partition number

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MEMORY.html[5/24/2011 12:36:49 PM]

MEMORY

totalAllocatedMemory totalFreedMemory totalPeakUsage

- sum of all MEM_malloc calls

- sum of all MEM_free calls

- peak usage of allocated memory

Returns:
void

- None

MEM_ReportTotalUsage

void MEM_ReportTotalUsage (UInt32 totalAllocatedMemory, UInt32 totalFreedMemory, UInt32 totalPeakUsage) Parameters:

Prints out the total memory usage statistics for the simulation. In a parallel run, the peak usage is the sum of the partition's peak usage and might not be precisely accurate.

totalAllocatedMemory totalFreedMemory totalPeakUsage

- sum of all MEM_malloc calls

- sum of all MEM_free calls

- peak usage of allocated memory

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MEMORY.html[5/24/2011 12:36:49 PM]

MESSAGE

EXata 2.2 API Specification

MESSAGE
This file describes the message structure used to implement events and functions for message operations. Constant / Data Structure Summary Type
CONSTANT

Name
MSG_MAX_HDR_SIZE

Maximum Header Size

CONSTANT SMALL_INFO_SPACE_SIZE

Size of small Info field. Should be larger than all commonly used info field data structures, especially PropTxInfo and PropRxInfo.
CONSTANT MSG_PAYLOAD_LIST_MAX

Maximum message payload list

CONSTANT MAX_CACHED_PAYLOAD_SIZE

Maximum cached payload size

CONSTANT MSG_INFO_LIST_MAX

Maximum message info list

CONSTANT MAX_INFO_FIELDS

Maximum number of info fields

CONSTANT MAX_HEADERS

Maximum number of headers

ENUMERATION MessageInfoType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Type of information in the info field. One message can only have up to one info field with a specific info type.
STRUCT MessageInfoHeader

This is a structure which contains information about a info field.

STRUCT Message

This is the main data strucure that represents a discrete event in qualnet. This is used to represent timer as well as to simulate actual sending of packets across the network.

Function / Macro Summary Return Type

void

Summary
MESSAGE_PrintMessage(Node* node, Message* msg)

void

MESSAGE_Send(Node* node, Message* msg, clocktype delay, bool isMT)

Function call used to send a message within QualNet. When a message is sent using this mechanism, only the pointer to the message is actually sent through the system. So the user has to be careful not to do anything with the content of the pointer once MESSAGE_Send has been called.
void MESSAGE_SendMT(Node* node, Message* msg, clocktype delay)

Function call used to send a message from independent threads running within QualNet, for example those associated with external interfaces.
void MESSAGE_RemoteSend(Node* node, NodeId destNodeId, Message* msg, clocktype delay)

Function used to send a message to a node that might be on a remote partition. The system will make a shallow copy of the message, meaning it can't contain any pointers in the info field or the packet itself. This function is very unsafe. If you use it, your program will probably crash. Only I can use it.
void MESSAGE_RouteReceivedRemoteEvent(Node* node, Message* msg)

Counterpart to MESSAGE_RemoteSend, this function allows models that send remote messages to provide special handling for them on the receiving partition. This function is called in real time as the messages are received, so must be used carefully.
void MESSAGE_CancelSelfMsg(Node* node, Message* msgToCancelPtr)

Function call used to cancel a event message in the QualNet scheduler. The Message must be a self message (timer) .i.e. a message a node sent to itself. The msgToCancelPtr must a pointer to the original message that needs to be canceled.
Message* (Node* node, int layerType, int protocol, int eventType)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

MESSAGE_Alloc

Allocate a new Message structure. This is called when a new message has to be sent through the system. The last three parameters indicate the layerType, protocol and the eventType that will be set for this message.
Message* MESSAGE_Alloc(PartitionData* partition, int layerType, int protocol, int eventType)

Allocate a new Message structure. This is called when a new message has to be sent through the system. The last three parameters indicate the layerType, protocol and the eventType that will be set for this message.
Message* MESSAGE_AllocMT(PartitionData* partition, int layerType, int protocol, int eventType)

Mutli-thread safe version of MESSAGE_Alloc for use by worker threads.

char* MESSAGE_InfoFieldAlloc(Node* node, int infoSize)

Allocate space for one "info" field

char* MESSAGE_InfoFieldAlloc(PartitionData* partition, int infoSize)

Allocate space for one "info" field

char* MESSAGE_InfoFieldAllocMT(PartitionData* partition, int infoSize)

Multi-thread safe version of MESSAGE_InfoFieldAlloc

void MESSAGE_InfoFieldFree(Node* node, MessageInfoHeader* hdrPtr)

Free space for one "info" field

char* MESSAGE_AddInfo(Node* node, Message* msg, int infoSize, unsigned short infoType)

Allocate one "info" field with given info type for the message. This function is used for the delivery of data for messages which are NOT packets as well as the delivery of extra information for messages which are packets. If a "info" field with the same info type has previously been allocated for the message, it will be replaced by a new "info" field with the specified size. Once this function has been called, MESSAGE_ReturnInfo function can be used to get a pointer to the allocated space for the info field in the message structure.
char* MESSAGE_AddInfo(PartitionData* partition, Message* msg, int infoSize, unsigned short infoType)

Allocate one "info" field with given info type for the message. This function is used for the delivery of data for messages which are NOT packets as well as the delivery of extra information for messages which are packets. If a "info" field with the same info type has previously been allocated for the message, it will be replaced by a new "info" field with the specified size. Once this function has been called, MESSAGE_ReturnInfo function can be used to get a pointer to the allocated space for the info field in the message structure.
void MESSAGE_RemoveInfo(Node* node, Message* msg, unsigned short infoType)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Remove one "info" field with given info type from the info array of the message.
char * MESSAGE_InfoAlloc(Node* node, Message* msg, int infoSize)

Allocate the default "info" field for the message. This function is similar to MESSAGE_AddInfo. The difference is that it assumes the type of the info field to be allocated is INFO_TYPE_DEFAULT.
char * MESSAGE_InfoAlloc(PartitionData* partition, Message* msg, int infoSize)

Allocate the default "info" field for the message. This function is similar to MESSAGE_AddInfo. The difference is that it assumes the type of the info field to be allocated is INFO_TYPE_DEFAULT.
int MESSAGE_ReturnInfoSize(Message* msg, unsigned short infoType, int fragmentNumber)

Returns the size of a "info" field with given info type in the info array of the message.
int MESSAGE_ReturnInfoSize(Message* msg, unsigned short infoType)

Returns the size of a "info" field with given info type in the info array of the message.
char* MESSAGE_ReturnInfo(Message* msg, unsigned short infoType)

Returns a pointer to the "info" field with given info type in the info array of the message.
void MESSAGE_CopyInfo(Node* node, Message* dsgMsg, Message* srcMsg)

Copy the "info" fields of the source message to the destination message.
void MESSAGE_CopyInfo(Node* node, Message* dsgMsg, MessageInfoHeader* srcInfo)

Copy the "info" fields of the source info header to the destination message.
void MESSAGE_FragmentPacket(Node* node, Message* msg, int fragUnit, Message*** fragList, int* numFrags, TraceProtocolType protocolType)

Fragment one packet into multiple fragments Note: The original packet will be freed in this function. The array for storing pointers to fragments will be dynamically allocated. The caller of this function will need to free the memory.
Message* MESSAGE_ReassemblePacket(Node* node, Message** fragList, int numFrags, TraceProtocolType protocolType)

Reassemble multiple fragments into one packet Note: All the fragments will be freed in this function.
Message* MESSAGE_PackMessage(Node* node, Message* msgList, TraceProtocolType origProtocol, int* actualPktSize)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Pack a list of messages to be one message structure Whole contents of the list messages will be put as payload of the new message. So the packet size of the new message cannot be directly used now. The original lis of msgs will be freed.
Message* MESSAGE_UnpackMessage(Node* node, Message* msg, bool copyInfo, bool freeOld)

Unpack a super message to the original list of messages The list of messages were stored as payload of this super message.
void MESSAGE_PacketAlloc(Node* node, Message* msg, int packetSize, TraceProtocolType originalProtocol)

Allocate the "payload" field for the packet to be delivered. Add additional free space in front of the packet for headers that might be added to the packet. This function can be called from the application layer or anywhere else (e.g TCP, IP) that a packet may originiate from. The "packetSize" variable will be set to the "packetSize" parameter specified in the function call. Once this function has been called the "packet" variable in the message structure can be used to access this space.
void MESSAGE_PacketAlloc(PartitionData* partition, Message* msg, int packetSize, TraceProtocolType originalProtocol, bool isMT)

Allocate the "payload" field for the packet to be delivered. Add additional free space in front of the packet for headers that might be added to the packet. This function can be called from the application layer or anywhere else (e.g TCP, IP) that a packet may originiate from. The "packetSize" variable will be set to the "packetSize" parameter specified in the function call. Once this function has been called the "packet" variable in the message structure can be used to access this space.
void MESSAGE_AddHeader(Node* node, Message* msg, int hdrSize, TraceProtocolType traceProtocol)

This function is called to reserve additional space for a header of size "hdrSize" for the packet enclosed in the message. The "packetSize" variable in the message structure will be increased by "hdrSize". Since the header has to be prepended to the current packet, after this function is called the "packet" variable in the message structure will point the space occupied by this new header.
void MESSAGE_RemoveHeader(Node* node, Message* msg, int hdrSize, TraceProtocolType traceProtocol)

This function is called to remove a header from the packet. The "packetSize" variable in the message will be decreased by "hdrSize".
char* MESSAGE_ReturnHeader(Message* msg, int header)

This is kind of a hack so that MAC protocols (dot11) that need to peak at a packet that still has the PHY header can return the contents after the first (N) headers without first removing those headers.
void MESSAGE_ExpandPacket(Node* node, Message* msg, int size)

Expand packet by a specified size

void MESSAGE_ShrinkPacket(Node* node, Message* msg, int size)

This function is called to shrink packet by a specified size.

void MESSAGE_Free(PartitionData* partition, Message* msg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

When the message is no longer needed it can be freed. Firstly the "payload" and "info" fields of the message are freed. Then the message itself is freed. It is important to remember to free the message. Otherwise there will nasty memory leaks in the program.
void MESSAGE_Free(Node* node, Message* msg)

Free a list of message until the next pointer of the message is NULL.
Message* MESSAGE_Duplicate(Node* node, Message* msg)

Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.
Message* MESSAGE_Duplicate(PartitionData* partition, Message* msg, bool isMT)

Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.
Message* MESSAGE_DuplicateMT(PartitionData* partition, Message* msg)

Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.
char* MESSAGE_PayloadAlloc(Node* node, int payloadSize)

Allocate a character payload out of the free list, if possible otherwise via malloc.
char* MESSAGE_PayloadAlloc(PartitionData* partition, int payloadSize, bool isMT)

Allocate a character payload out of the free list, if possible otherwise via malloc.
void MESSAGE_PayloadFree(PartitionData* partition, Char* payload, int payloadSize)

Return a character payload to the free list, if possible otherwise free it.
void MESSAGE_PayloadFree(Node* node, Char* payload, int payloadSize)

Return a character payload to the free list, if possible otherwise free it.
void MESSAGE_FreeList(Node* node, Message* msg)

Free a list of messages until the next pointer of the message is NULL.
int MESSAGE_ReturnNumFrags(Message* msg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns the number of fragments used to create a TCP packet.

int MESSAGE_ReturnFragSeqNum(Message* msg, int fragmentNumber)

Returns the sequence number of a particular fragments in the TCP packet.

int MESSAGE_ReturnFragSize(Message* msg, int fragmentNumber)

Returns the size of a particular fragment in the TCP packet.

int MESSAGE_ReturnFragNumInfos(Message* msg, int fragmentNumber)

Returns the number of info fields associated with a particular fragment in the TCP packet.
void MESSAGE_AppendInfo(Node* node, Message* msg, int infosize, short infoType)

Appends the "info" fields of the source message to the destination message.
void MESSAGE_AppendInfo(Node* node, Message* dsgMsg, MessageInfoHeader* srcInfo)

Appends the "info" fields of the source message to the destination message.
void MESSAGE_AppendInfo(Node* node, Message* dsgMsg, Message* srcMsg)

Appends the "info" fields of the source message to the destination message.
size_t MESSAGE_SizeOf()

Returns the size of a message. Used in place of sizeof() in the kernel code to allow for users to add more fields to the message.
BOOL MESSAGE_FragmentPacket(Node* node, Message*& msg, Message*& fragmentedMsg, Message*& remainingMsg, int fragUnit, TraceProtocolType protocolType, bool freeOriginalMsg)

Fragment one packet into TWO fragments Note:(i) This API treats the original packet as raw packet and does not take account of fragmentation related information like fragment id. The caller of this API will have to itself put in logic for distinguishing the fragmented packets (ii) Overloaded MESSAGE_FragmentPacket
Message* MESSAGE_ReassemblePacket(Node* node, Message* fragMsg1, Message* fragMsg2, TraceProtocolType protocolType)

Reassemble TWO fragments into one packet Note: (i) None of the fragments will be freed in this API. The caller of this API will itself have to free the fragments (ii) Overloaded MESSAGE_ReassemblePacket
void MESSAGE_SendAsEarlyAsPossible(Node* node, Message* msg)

Constant

Maximum cached payload size MSG_INFO_LIST_MAX 1000

Constant

Maximum message info list MAX_INFO_FIELDS 12

Constant

Maximum number of info fields MAX_HEADERS 10

Enumeration

Maximum number of headers MessageInfoType

Structure

Type of information in the info field. One message can only have up to one info field with a specific info type. MessageInfoHeader

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Structure

This is a structure which contains information about a info field. Message

This is the main data strucure that represents a discrete event in qualnet. This is used to represent timer as well as to simulate actual sending of packets across the network.

Function / Macro Detail Function / Macro MESSAGE_PrintMessage Format void MESSAGE_PrintMessage (Node* node, Message* msg) Parameters:
node msg

- node which is sending message

- message to be printed

Returns:
void

- NULL

MESSAGE_Send

void MESSAGE_Send (Node* node, Message* msg, clocktype delay, bool isMT) Parameters:

node msg

- node which is sending message

- message to be delivered - delay suffered by this message.

delay isMT

- is the function being called from a thread?

Returns:
void

- NULL

MESSAGE_SendMT

void MESSAGE_SendMT (Node* node, Message* msg, clocktype delay) Parameters:

Function call used to send a message from independent threads running within QualNet, for example those associated with external interfaces.

node msg

- node which is sending message

- message to be delivered - delay suffered by this message.

delay

Returns:
void
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

- NULL MESSAGE_RemoteSend void MESSAGE_RemoteSend (Node* node, NodeId destNodeId, Message* msg, clocktype delay) Parameters: Function used to send a message to a node that might be on a remote partition. The system will make a shallow copy of the message, meaning it can't contain any pointers in the info field or the packet itself. This function is very unsafe. If you use it, your program will probably crash. Only I can use it.
node

- node which is sending message - nodeId of receiving node

destNodeId msg

- message to be delivered - delay suffered by this message.

delay

Returns:
void

- NULL

MESSAGE_RouteReceivedRemoteEvent

void MESSAGE_RouteReceivedRemoteEvent (Node* node, Message* msg) Parameters:

node msg

- node which is sending message

- message to be delivered

Returns:
void

- NULL

void MESSAGE_CancelSelfMsg (Node* node, Message* msgToCancelPtr) Parameters:

node

- node which is sending message - message to be cancelled

msgToCancelPtr

Returns:
void

- NULL

Message* MESSAGE_Alloc (Node* node, int layerType, int protocol, int eventType) Parameters:

node

- node which is allocating message - Layer type to be set for this message

layerType protocol

- Protocol to be set for this message - event type to be set for this message

eventType

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Message*

- Pointer to allocated message structure

MESSAGE_Alloc

Message* MESSAGE_Alloc (PartitionData* partition, int layerType, int protocol, int eventType) Parameters:

partition layerType protocol

- partition that is allocating message - Layer type to be set for this message

- Protocol to be set for this message - event type to be set for this message

eventType

Returns:
Message*

- Pointer to allocated message structure

MESSAGE_AllocMT

Message* MESSAGE_AllocMT (PartitionData* partition, int layerType, int protocol, int eventType) Parameters:

Mutli-thread safe version of MESSAGE_Alloc for use by worker threads.

partition layerType protocol

- partition that is allocating message - Layer type to be set for this message

- Protocol to be set for this message - event type to be set for this message

eventType

Returns:
Message*

- Pointer to allocated message structure

MESSAGE_InfoFieldAlloc

char* MESSAGE_InfoFieldAlloc (Node* node, int infoSize) Parameters:

Allocate space for one "info" field

node

- node which is allocating the space. - size of the space to be allocated

infoSize

Returns:
char*

- pointer to the allocated space.

MESSAGE_InfoFieldAlloc

char* MESSAGE_InfoFieldAlloc (PartitionData* partition, int infoSize) Parameters:

Allocate space for one "info" field

partition infoSize

- partition which is allocating the space.

- size of the space to be allocated

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns:
char*

- pointer to the allocated space.

MESSAGE_InfoFieldAllocMT

char* MESSAGE_InfoFieldAllocMT (PartitionData* partition, int infoSize) Parameters:

Multi-thread safe version of MESSAGE_InfoFieldAlloc

partition infoSize

- partition which is allocating the space.

- size of the space to be allocated

Returns:
char*

- pointer to the allocated space.

MESSAGE_InfoFieldFree

void MESSAGE_InfoFieldFree (Node* node, MessageInfoHeader* hdrPtr) Parameters:

Free space for one "info" field

node

- node which is allocating the space. - pointer to the "info" field

hdrPtr

Returns:
void

- NULL

MESSAGE_AddInfo

char* MESSAGE_AddInfo (Node* node, Message* msg, int infoSize, unsigned short infoType) Parameters:

node msg

- node which is allocating the info field.

- message for which "info" field - size of the "info" field to be allocated - type of the "info" field to be allocated.

infoSize infoType

Returns:
char*

- Pointer to the added info field

char* MESSAGE_AddInfo (PartitionData* partition, Message* msg, int infoSize, unsigned short infoType) Parameters:

partition msg

- partition which is allocating the info field.

- message for which "info" field - size of the "info" field to be allocated

infoSize

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

If a "info" field with the same info type has previously been allocated for the message, it will be replaced by a new "info" field with the specified size. Once this function has been called, MESSAGE_ReturnInfo function can be used to get a pointer to the allocated space for the info field in the message structure. MESSAGE_RemoveInfo

infoType

- type of the "info" field to be allocated.

Returns:
char*

- Pointer to the added info field

void MESSAGE_RemoveInfo (Node* node, Message* msg, unsigned short infoType) Parameters:

Remove one "info" field with given info type from the info array of the message.

node msg

- node which is removing info field.

- message for which "info" field - type of the "info" field to be removed.

infoType

Returns:
void

- NULL

MESSAGE_InfoAlloc

char * MESSAGE_InfoAlloc (Node* node, Message* msg, int infoSize) Parameters:

Allocate the default "info" field for the message. This function is similar to MESSAGE_AddInfo. The difference is that it assumes the type of the info field to be allocated is INFO_TYPE_DEFAULT.

node msg

- node which is allocating the info field.

- message for which "info" field - size of the "info" field to be allocated

infoSize

Returns:
char *

- None

MESSAGE_InfoAlloc

char * MESSAGE_InfoAlloc (PartitionData* partition, Message* msg, int infoSize) Parameters:

Allocate the default "info" field for the message. This function is similar to MESSAGE_AddInfo. The difference is that it assumes the type of the info field to be allocated is INFO_TYPE_DEFAULT.

partition msg

- partition which is allocating the info field.

- message for which "info" field - size of the "info" field to be allocated

infoSize

Returns:
char *

- None

MESSAGE_ReturnInfoSize

int MESSAGE_ReturnInfoSize (Message* msg, unsigned short infoType, int fragmentNumber) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns the size of a "info" field with given info type in the info array of the message.

msg

- message for which "info" field - type of the "info" field. - Location of the fragment in the TCP packet

infoType

fragmentNumber

Returns:
int

- size of the info field.

MESSAGE_ReturnInfoSize

int MESSAGE_ReturnInfoSize (Message* msg, unsigned short infoType) Parameters:

Returns the size of a "info" field with given info type in the info array of the message.

msg

- message for which "info" field - type of the "info" field.

infoType

Returns:
int

- size of the info field.

MESSAGE_ReturnInfo

char* MESSAGE_ReturnInfo (Message* msg, unsigned short infoType) Parameters:

Returns a pointer to the "info" field with given info type in the info array of the message.

msg

- message for which "info" field - type of the "info" field to be returned.

infoType

Returns:
char*

- Pointer to the "info" field with given type. NULL if not found.

MESSAGE_CopyInfo

void MESSAGE_CopyInfo (Node* node, Message* dsgMsg, Message* srcMsg) Parameters:

Copy the "info" fields of the source message to the destination message.

node

- Node which is copying the info fields - Destination message - Source message

dsgMsg srcMsg

Returns:
void

- NULL

MESSAGE_CopyInfo

void MESSAGE_CopyInfo (Node* node, Message* dsgMsg, MessageInfoHeader* srcInfo) Parameters:

Copy the "info" fields of the source info header to the destination message.

node

- Node which is copying the info fields - Destination message

dsgMsg

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

srcInfo

- Info Header structure

Returns:
void

- NULL

MESSAGE_FragmentPacket

void MESSAGE_FragmentPacket (Node* node, Message* msg, int fragUnit, Message*** fragList, int* numFrags, TraceProtocolType protocolType) Parameters:

node msg

- node which is fragmenting the packet

- The packet to be fragmented - The unit size for fragmenting the packet - A list of fragments created. - Number of fragments in the fragment list. - Protocol type for packet tracing.

fragUnit fragList numFrags

protocolType

Returns:
void

- NULL

MESSAGE_ReassemblePacket

Message* MESSAGE_ReassemblePacket (Node* node, Message** fragList, int numFrags, TraceProtocolType protocolType) Parameters:

Reassemble multiple fragments into one packet Note: All the fragments will be freed in this function.

node

- node which is assembling the packet - A list of fragments. - Number of fragments in the fragment list. - Protocol type for packet tracing.

fragList numFrags

protocolType

Returns:
Message*

- The reassembled packet.

MESSAGE_PackMessage

Message* MESSAGE_PackMessage (Node* node, Message* msgList, TraceProtocolType origProtocol, int* actualPktSize) Parameters:

node

- Pointer to node. - Pointer to a list of messages - Protocol allocating this packet - For return sum of packet size of msgs in list

msgList

origProtocol

actualPktSize

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns:
Message*

- The super msg contains a list of msgs as payload

MESSAGE_UnpackMessage

Message* MESSAGE_UnpackMessage (Node* node, Message* msg, bool copyInfo, bool freeOld) Parameters:

Unpack a super message to the original list of messages The list of messages were stored as payload of this super message.

node msg

- Pointer to node.

- Pointer to the supper msg contains list of msgs - Whether copy info from old msg to first msg

copyInfo freeOld

- Whether the original message should be freed

Returns:
Message*

- A list of messages unpacked from original msg

MESSAGE_PacketAlloc

void MESSAGE_PacketAlloc (Node* node, Message* msg, int packetSize, TraceProtocolType originalProtocol) Parameters:

node msg

- node which is allocating the packet

- message for which packet has to be allocated - size of the packet to be allocated - Protocol allocating this packet

packetSize

originalProtocol

Returns:
void

- NULL

void MESSAGE_PacketAlloc (PartitionData* partition, Message* msg, int packetSize, TraceProtocolType originalProtocol, bool isMT) Parameters:

partition msg

- artition which is allocating the packet

- message for which packet has to be allocated - size of the packet to be allocated - Protocol allocating this packet

packetSize

originalProtocol isMT

- Is this packet being created from a worker thread

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

MESSAGE_AddHeader

void MESSAGE_AddHeader (Node* node, Message* msg, int hdrSize, TraceProtocolType traceProtocol) Parameters:

node msg

- node which is adding header

- message for which header has to be added - size of the header to be added - protocol name, from trace.h

hdrSize

traceProtocol

Returns:
void

- NULL

void MESSAGE_RemoveHeader (Node* node, Message* msg, int hdrSize, TraceProtocolType traceProtocol) Parameters:

This function is called to remove a header from the packet. The "packetSize" variable in the message will be decreased by "hdrSize".

node msg

- node which is removing the packet header

- message for which header is being removed - size of the header being removed - protocol removing this header.

hdrSize

traceProtocol

Returns:
void

- NULL

MESSAGE_ReturnHeader

char* MESSAGE_ReturnHeader (Message* msg, int header) Parameters:

msg

- message containing a packet with headers - number of the header to return.

header

Returns:
char*

- the packet starting at the header'th header

MESSAGE_ExpandPacket

void MESSAGE_ExpandPacket (Node* node, Message* msg, int size) Parameters:

Expand packet by a specified size

node msg

- node which is expanding the packet

- message which is to be expanded - size to expand

size

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns:
void

- NULL

MESSAGE_ShrinkPacket

void MESSAGE_ShrinkPacket (Node* node, Message* msg, int size) Parameters:

This function is called to shrink packet by a specified size.

node msg

- node which is shrinking packet

- message whose packet is be shrinked - size to shrink

size

Returns:
void

- message which has to be freed

Returns:
void

- NULL

MESSAGE_Duplicate

Message* MESSAGE_Duplicate (Node* node, Message* msg)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Parameters: Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.
node msg

- node is calling message copy

- message for which duplicate has to be made

Returns:
Message*

- Pointer to the new message

MESSAGE_Duplicate

Message* MESSAGE_Duplicate (PartitionData* partition, Message* msg, bool isMT) Parameters:

Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.

partition msg

- partition is calling message copy

- message for which duplicate has to be made - Is this function being called from the context

isMT

Returns:
Message*

- Pointer to the new message

MESSAGE_DuplicateMT

Message* MESSAGE_DuplicateMT (PartitionData* partition, Message* msg) Parameters:

Create a new message which is an exact duplicate of the message supplied as the parameter to the function and return the new message.

partition msg

- partition is calling message copy

- message for which duplicate has to be made

Returns:
Message*

- Pointer to the new message

MESSAGE_PayloadAlloc

char* MESSAGE_PayloadAlloc (Node* node, int payloadSize) Parameters:

Allocate a character payload out of the free list, if possible otherwise via malloc.

node

- node which is allocating payload - size of the field to be allocated

payloadSize

Returns:
char*

- pointer to the allocated memory

MESSAGE_PayloadAlloc

char* MESSAGE_PayloadAlloc (PartitionData* partition, int payloadSize, bool isMT) Parameters:

Allocate a character payload out of the free list, if possible otherwise via malloc.

partition

- partition which is allocating payload

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

payloadSize isMT

- size of the field to be allocated

- Is this packet being created from a worker thread

Returns:
char*

- pointer to the allocated memory

MESSAGE_PayloadFree

void MESSAGE_PayloadFree (PartitionData* partition, Char* payload, int payloadSize) Parameters:

Return a character payload to the free list, if possible otherwise free it.

partition payload

- partition which is freeing payload

- Pointer to the payload field - size of the payload field

payloadSize

Returns:
void

- NULL

MESSAGE_PayloadFree

void MESSAGE_PayloadFree (Node* node, Char* payload, int payloadSize) Parameters:

Return a character payload to the free list, if possible otherwise free it.

node

- node which is freeing payload - Pointer to the payload field - size of the payload field

payload

payloadSize

Returns:
void

- NULL

MESSAGE_FreeList

void MESSAGE_FreeList (Node* node, Message* msg) Parameters:

Free a list of messages until the next pointer of the message is NULL.

node msg

- node which is freeing the message

- message which has to be freed

Returns:
void

- NULL

MESSAGE_ReturnNumFrags

int MESSAGE_ReturnNumFrags (Message* msg) Parameters:

Returns the number of fragments used to create a TCP packet.

msg

- message for which "info" field

- message for which "info" field - fragment location in the TCP message.

fragmentNumber

Returns:
int

- Sequence number of the fragment. 0 if none.

MESSAGE_AppendInfo

void MESSAGE_AppendInfo (Node* node, Message* msg, int infosize, short infoType) Parameters:

Appends the "info" fields of the source message to the destination message.

node msg

- Node which is copying the info fields

- Destination message - size of the info field - type of info field.

infosize infoType

Returns:
void

- NULL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

MESSAGE_AppendInfo

void MESSAGE_AppendInfo (Node* node, Message* dsgMsg, MessageInfoHeader* srcInfo) Parameters:

Appends the "info" fields of the source message to the destination message.

node

- Node which is copying the info fields - Destination message - Source message info vector

dsgMsg

srcInfo

Returns:
void

- NULL

MESSAGE_AppendInfo

void MESSAGE_AppendInfo (Node* node, Message* dsgMsg, Message* srcMsg) Parameters:

Appends the "info" fields of the source message to the destination message.

node

- Node which is copying the info fields - Destination message - Source message

dsgMsg srcMsg

Returns:
void

- NULL

MESSAGE_SizeOf

size_t MESSAGE_SizeOf () Parameters:

Returns the size of a message. Used in place of sizeof() in the kernel code to allow for users to add more fields to the message. MESSAGE_FragmentPacket

Returns:
size_t

- sizeof(msg)

BOOL MESSAGE_FragmentPacket (Node* node, Message*& msg, Message*& fragmentedMsg, Message*& remainingMsg, int fragUnit, TraceProtocolType protocolType, bool freeOriginalMsg) Parameters:

node msg

- node which is fragmenting the packet

- The packet to be fragmented - First fragment

fragmentedMsg remainingMsg fragUnit

- Remaining packet

- The unit size for fragmenting the packet - Protocol type for packet tracing. - If TRUE, then original msg is set to NULL

protocolType

freeOriginalMsg

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MESSAGE

Returns:
BOOL

- TRUE if any fragment is created, FALSE otherwise

MESSAGE_ReassemblePacket

Message* MESSAGE_ReassemblePacket (Node* node, Message* fragMsg1, Message* fragMsg2, TraceProtocolType protocolType) Parameters:

node

- node which is assembling the packet - First fragment - Second fragment - Protocol type for packet tracing.

fragMsg1 fragMsg2

protocolType

Returns:
Message*

- The reassembled packet.

MESSAGE_SendAsEarlyAsPossible

void MESSAGE_SendAsEarlyAsPossible (Node* node, Message* msg) Parameters:

This function is used primarily by external interfaces to inject events into the Simulator as soon as possible without causing problems for parallel execution.

node msg

- node which is sending message

- message to be delivered

Returns:
void

- NULL

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MESSAGE.html[5/24/2011 12:37:03 PM]

MOBILITY

EXata 2.2 API Specification

MOBILITY
This file describes data structures and functions used by mobility models. Constant / Data Structure Summary Type
CONSTANT

Name
DEFAULT_DISTANCE_GRANULARITY

Defines the default distance granurality

CONSTANT NUM_NODE_PLACEMENT_TYPES

Defines the number of node placement schemes

CONSTANT NUM_MOBILITY_TYPES

Defines the number of mobility models

CONSTANT NUM_PAST_MOBILITY_EVENTS

Number of past mobility models stored

ENUMERATION NodePlacementType

Specifies different node placement schemes

ENUMERATION MobilityType

Specifies different mobility models

STRUCT MobilityHeap

A Heap that determines the earliest time

STRUCT MobilityElement

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Defines all the element of mobility model.

STRUCT MobilityRemainder

A structure that defines the next states of the elements of mobility model.
STRUCT MobilityData

This structure keeps the data related to mobility model. It also holds the variables which are static and variable during the simulation. Buffer caches future position updates as well.

Function / Macro Summary Return Type

void

Summary
MOBILITY_InsertEvent(MobilityHeap* heapPtr, Node* node)

Inserts an event.
void MOBILITY_DeleteEvent(MobilityHeap* heapPtr, Node* node)

Deletes an event.
void MOBILITY_HeapFixDownEvent(MobilityHeap* heapPtr, int i)

Inserts an event and sort out the heap downwards

void MOBILITY_AllocateNodePositions(int numNodes, NodeAddress* nodeIdArray, NodePositions** nodePositions, int** nodePlacementTypeCounts, NodeInput* nodeInput, int seedVal)

Allocates memory for nodePositions and mobilityData Note: This function is called before NODE_CreateNode(). It cannot access Node structure
void MOBILITY_PreInitialize(NodeAddress nodeId, MobilityData* mobilityData, NodeInput* nodeInput, int seedVal)

Initializes most variables in mobilityData. (Node positions are set in MOBILITY_SetNodePositions().) Note: This function is called before NODE_CreateNode(). It cannot access Node structure
void MOBILITY_PostInitialize(Node* node, NodeInput* nodeInput)

Initializes variables in mobilityData not initialized by MOBILITY_PreInitialize().

void MOBILITY_UpdatePathProfiles(MobilityHeap* pathProfileHeap, clocktype nextEventTime, clocktype* upperBoundTime)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Updates the path profiles.

void MOBILITY_Finalize(Node* node)

Called at the end of simulation to collect the results of the simulation of the mobility data.
void MOBILITY_ProcessEvent(Node* node)

Models the behaviour of the mobility models on receiving a message.

void MOBILITY_AddANewDestination(MobilityData* mobilityData, clocktype arrivalTime, Coordinates dest, Orientation orientation, double zValue)

Adds a new destination.

BOOL MOBILITY_NextPosition(Node* node, MobilityElement* element)

Update next node position for static mobility models

clocktype MOBILITY_NextMoveTime(Node* node)

Determines the time of next movement.

MobilityElement* MOBILITY_ReturnMobilityElement(Node* node, int sequenceNum)

Used to get the mobility element.

void MOBILITY_InsertANewEvent(Node* node, clocktype nextMoveTime, Coordinates position, Orientation orientation, double speed)

Inserts a new event.

bool MOBILITY_NodeIsIndoors(Node* node)

Returns whether the node is indoors.

void MOBILITY_SetIndoors(Node* node, bool indoors)

Sets the node's indoor variable.

void MOBILITY_ReturnCoordinates(Node* node, Coordinates position)

Returns the coordinate.

void MOBILITY_ReturnOrientation(Node* node, Orientation* orientation)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Returns the node orientation.

void MOBILITY_ReturnInstantaneousSpeed(Node* node, double* speed)

Returns instantaneous speed of a node.

void MOBILITY_ReturnSequenceNum(Node* node, int* sequenceNum)

Returns a sequence number for the current position.

void MOBILITY_SetNodePositions(int numNodes, NodePositions* nodePositions, int* nodePlacementTypeCounts, TerrainData* terrainData, NodeInput* nodeInput, RandomSeed seed, clocktype maxSimTime)

Set positions of nodes

void MOBILITY_PostInitializePartition(PartitionData* partitionData)

Initialization of mobility models that most be done after partition is created; MOBILITY_SetNodePositions would be too early
void MOBILITY_NodePlacementFinalize(PartitionData* partitionData)

Finalize mobility models

void MOBILITY_ChangeGroundNode(Node* node, BOOL before, BOOL after)

Change GroundNode value..

void MOBILITY_ChangePositionGranularity(Node* node)

Change Mobility-Position-Granularity value..

Constant / Data Structure Detail

Constant

DEFAULT_DISTANCE_GRANULARITY 1

Constant

Defines the default distance granurality NUM_NODE_PLACEMENT_TYPES 7

Defines the number of node placement schemes

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Constant

NUM_MOBILITY_TYPES 5

Structure

A structure that defines the next states of the elements of mobility model. MobilityData

This structure keeps the data related to mobility model. It also holds the variables which are static and variable during the simulation. Buffer caches future position updates as well.

Function / Macro Detail Function / Macro MOBILITY_InsertEvent Format void MOBILITY_InsertEvent (MobilityHeap* heapPtr, Node* node) Parameters: Inserts an event.
heapPtr

- A pointer of type MobilityHeap.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

node

- A pointer to node.

Returns:
void

- None

MOBILITY_DeleteEvent

void MOBILITY_DeleteEvent (MobilityHeap* heapPtr, Node* node) Parameters:

Deletes an event.

heapPtr node

- A pointer of type MobilityHeap.

- A pointer to node.

Returns:
void

- None

MOBILITY_HeapFixDownEvent

void MOBILITY_HeapFixDownEvent (MobilityHeap* heapPtr, int i) Parameters:

Inserts an event and sort out the heap downwards

heapPtr i

- A pointer of type MobilityHeap.

- index

Returns:
void

- None

MOBILITY_AllocateNodePositions

void MOBILITY_AllocateNodePositions (int numNodes, NodeAddress* nodeIdArray, NodePositions** nodePositions, int** nodePlacementTypeCounts, NodeInput* nodeInput, int seedVal) Parameters:

Allocates memory for nodePositions and mobilityData Note: This function is called before NODE_CreateNode(). It cannot access Node structure

numNodes

- number of nodes - array of nodeId - pointer to the array - array of placement type counts

nodeIdArray

nodePositions

nodePlacementTypeCounts nodeInput seedVal

- configuration input

- seed for random number seeds

Returns:
void

- None

MOBILITY_PreInitialize

void MOBILITY_PreInitialize (NodeAddress nodeId, MobilityData* mobilityData, NodeInput* nodeInput, int seedVal) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Initializes most variables in mobilityData. (Node positions are set in MOBILITY_SetNodePositions().) Note: This function is called before NODE_CreateNode(). It cannot access Node structure

nodeId

- nodeId - mobilityData to be initialized

mobilityData nodeInput seedVal

- configuration input

- seed for random number seeds

Returns:
void

- None

MOBILITY_PostInitialize

void MOBILITY_PostInitialize (Node* node, NodeInput* nodeInput) Parameters:

Initializes variables in mobilityData not initialized by MOBILITY_PreInitialize().

node

- node being initialized - structure containing contents of input file

nodeInput

MOBILITY

on receiving a message. Returns:

void

- None

MOBILITY_AddANewDestination

void MOBILITY_AddANewDestination (MobilityData* mobilityData, clocktype arrivalTime, Coordinates dest, Orientation orientation, double zValue) Parameters:

Adds a new destination.

mobilityData arrivalTime dest

- MobilityData of the node

- Arrival time

- Destination - Orientation

orientation zValue

- original zValue

Returns:
void

- None

MOBILITY_NextPosition

BOOL MOBILITY_NextPosition (Node* node, MobilityElement* element) Parameters:

Update next node position for static mobility models

node

- Node to be updated - next mobility update

element

Returns:
BOOL

- None

MOBILITY_NextMoveTime

clocktype MOBILITY_NextMoveTime (Node* node) Parameters:

Determines the time of next movement.

node

- Pointer to node.

Returns:
clocktype

- Next time of movement.

MOBILITY_ReturnMobilityElement

MobilityElement* MOBILITY_ReturnMobilityElement (Node* node, int sequenceNum) Parameters:

Used to get the mobility element.

node

- Pointer to node. - Sequence number.

sequenceNum

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

MobilityElement*

- None

MOBILITY_InsertANewEvent

void MOBILITY_InsertANewEvent (Node* node, clocktype nextMoveTime, Coordinates position, Orientation orientation, double speed) Parameters:

Inserts a new event.

node

- Pointer to node. - Time of next movement.

nextMoveTime position

- Position of the node. - Node orientation.

orientation speed

- Speed of the node.

Returns:
void

- None

MOBILITY_NodeIsIndoors

bool MOBILITY_NodeIsIndoors (Node* node) Parameters:

Returns whether the node is indoors.

node

- Pointer to node.

Returns:
bool

- returns true if indoors.

MOBILITY_SetIndoors

void MOBILITY_SetIndoors (Node* node, bool indoors) Parameters:

Sets the node's indoor variable.

node

- Pointer to node. - true if the node is indoors.

indoors

Returns:
void

- None

MOBILITY_ReturnCoordinates

void MOBILITY_ReturnCoordinates (Node* node, Coordinates position) Parameters:

Returns the coordinate.

node

- Pointer to node. - Position of the node.

position

Returns:
void

sequenceNum

Returns:
void

- None

MOBILITY_SetNodePositions

void MOBILITY_SetNodePositions (int numNodes, NodePositions* nodePositions, int* nodePlacementTypeCounts, TerrainData* terrainData, NodeInput* nodeInput, RandomSeed seed, clocktype maxSimTime) Parameters:

Set positions of nodes

numNodes

- Defines the number of nodes to be distributed. - Pointer to NodePositionInfo. States - Array of placement type counts

nodePositions

nodePlacementTypeCounts terrainData nodeInput seed

- Terrain data.

- Pointer to NodeInput, defines the

- Stores the seed value. - Maximum simulation time.

maxSimTime

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

Returns:
void

- None

MOBILITY_PostInitializePartition

void MOBILITY_PostInitializePartition (PartitionData* partitionData) Parameters:

Initialization of mobility models that most be done after partition is created; MOBILITY_SetNodePositions would be too early MOBILITY_NodePlacementFinalize

partitionData

- Pointer to the partition data

Returns:
void

- None

void MOBILITY_NodePlacementFinalize (PartitionData* partitionData) Parameters:

Finalize mobility models

partitionData

- Pointer to the partition data

Returns:
void

- None

MOBILITY_ChangeGroundNode

void MOBILITY_ChangeGroundNode (Node* node, BOOL before, BOOL after) Parameters:

Change GroundNode value..

node

- Pointer to node being initialized. - Orginal value for Ground-Node variable

before after

- new value for Ground-Node variable.

Returns:
void

- None

MOBILITY_ChangePositionGranularity

void MOBILITY_ChangePositionGranularity (Node* node) Parameters:

Change Mobility-Position-Granularity value..

node

- Pointer to node being initialized.

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MOBILITY

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MOBILITY.html[5/24/2011 12:37:41 PM]

MUTEX

EXata 2.2 API Specification

MUTEX
This file describes objects for use in creating critical regions (synchronized access) for global variables or data structures that have to be shared between threads. Function / Macro Summary Return Type
None

Summary
QNThreadLock(QNThreadMutex mutex)

This constructor is used to begin a critical region.

None QNPartitionLock(QNPartitionMutex mutex)

This constructor is used to begin a critical region.

Function / Macro Detail Function / Macro QNThreadLock Format None QNThreadLock (QNThreadMutex mutex) Parameters: This constructor is used to begin a critical region.
mutex

- Pointer to the Thread mutex to lock for this

Returns:
None

- None

QNPartitionLock

None QNPartitionLock (QNPartitionMutex mutex) Parameters:

This constructor is used to begin a critical region.

mutex

- Pointer to the Partition mutex to lock

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MUTEX.html[5/24/2011 12:37:51 PM]

MUTEX

None

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/MUTEX.html[5/24/2011 12:37:51 PM]

NETWORK LAYER

EXata 2.2 API Specification

NETWORK LAYER
This file describes the data structures and functions used by the Network Layer. Constant / Data Structure Summary Type
CONSTANT

Name
DEFAULT_IP_QUEUE_COUNT

Default number of output queue per interface

CONSTANT DEFAULT_CPU_QUEUE_SIZE

Default size of CPU queue (in byte)

CONSTANT DEFAULT_NETWORK_INPUT_QUEUE_SIZE

Default size in bytes of an input queue, if it's not specified in the input file with the IP-QUEUE-PRIORITY-INPUT-QUEUE-SIZE parameter.
CONSTANT DEFAULT_NETWORK_OUTPUT_QUEUE_SIZE

Default size in bytes of an output queue, if it's not specified in the input file with the IP-QUEUE-PRIORITY-QUEUE-SIZE parameter.
CONSTANT DEFAULT_ETHERNET_MTU

Default Ethernet MTU(Maximum transmission unit) in bytes. QualNet does not model Ethernet yet, but this value is used (in the init functions in network/fifoqueue.c and network/redqueue.c) to compute the initial number of Message * instances that are used to store packets in queues.Regardless, the buffer capacity of a queue is not the number of Message * instances, but a certain number of bytes, as expected.
CONSTANT IP_MAXPACKET

Maximum IP packet size

CONSTANT NETWORK_IP_UNLIMITED_BACKPLANE_THROUGHPUT

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NETWORK LAYER

Maximum throughput of backplane of network.

ENUMERATION NetworkIpBackplaneStatusType

Status of backplane (either busy or idle)

ENUMERATION NetworkRoutingAdminDistanceType

Administrative distance of different routing protocol

ENUMERATION NetworkRoutingProtocolType

Enlisted different network/routing protocol

ENUMERATION ManagementReportType

Type of management report message

ENUMERATION ManagementResponseType

Type of management response message

STRUCT NetworkData

Main data structure of network layer

STRUCT ManagementReport

data structure of management report

STRUCT ManagementResponse

data structure of management response

Function / Macro Summary Return Type

void

Summary
NETWORK_ManagementReport(Node* node, int interfaceIndex, ManagementReport* report, ManagementReportResponse* resp)

Deliver a MAC management request to the NETWORK layer

void NetworkGetInterfaceInfo()(Node* node, int interfaceIndex, Address* address)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NETWORK LAYER

Returns interface information for a interface. Information means its address and type
void NetworkIpGetInterfaceAddressString(Node* node, int interfaceIndex, const char* ipAddrString)

ipAddrString is filled in by interface's ipv6 address in character format.

NetworkType NetworkIpGetInterfaceType(Node* node, int interfaceIndex)

Returns type of network (ipv4 or ipv6) the interface.

void NETWORK_ReceivePacketFromMacLayer(Node* node, Message* message, NodeAddress lastHopAddress, int interfaceIndex)

Network-layer receives packets from MAC layer, now check Overloaded Function to support Mac Address type of IP and call proper function
void NETWORK_Reset(Node* node, int interfaceIndex)

Reset Network protocols and/or layer.

void NETWORK_AddResetFunctionList(Node* node, int interfaceIndex)

Add which protocols to be reset to a fuction list pointer.

Constant / Data Structure Detail

Constant

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NETWORK LAYER

Structure

data structure of management report ManagementResponse

data structure of management response

Function / Macro Detail Function / Macro NETWORK_ManagementReport Format void NETWORK_ManagementReport (Node* node, int interfaceIndex, ManagementReport* report, ManagementReportResponse* resp) Parameters: Deliver a MAC management request to the NETWORK layer
node

- Pointer to a network node - index of interface

interfaceIndex report resp

- Pointer to a management report

- Pointer to a management response

Returns:
void

- None

NetworkGetInterfaceInfo()

void NetworkGetInterfaceInfo() (Node* node, int interfaceIndex, Address* address) Parameters:

Returns interface information for a interface. Information means its address and type

node

- Pointer to node. - interface index for which info required.

interfaceIndex address

- interface info returned

Returns:
void

- NULL

NetworkIpGetInterfaceAddressString

void NetworkIpGetInterfaceAddressString (Node* node, int interfaceIndex, const char* ipAddrString) Parameters:

ipAddrString is filled in by interface's ipv6 address in character format.

node

- Pointer to node. - Interface index.

interfaceIndex

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NETWORK LAYER

ipAddrString

- Pointer to string ipv6 address.

Returns:
void

- None

NetworkIpGetInterfaceType

NetworkType NetworkIpGetInterfaceType (Node* node, int interfaceIndex) Parameters:

Returns type of network (ipv4 or ipv6) the interface.

node

- Pointer to node. - Interface index.

interfaceIndex

Returns:
NetworkType

- None

NETWORK_ReceivePacketFromMacLayer

void NETWORK_ReceivePacketFromMacLayer (Node* node, Message* message, NodeAddress lastHopAddress, int interfaceIndex) Parameters:

Network-layer receives packets from MAC layer, now check Overloaded Function to support Mac Address type of IP and call proper function

node

- Pointer to node - Message received - last hop address - incoimg interface

message

lastHopAddress interfaceIndex

Returns:
void

- None

NETWORK_Reset

void NETWORK_Reset (Node* node, int interfaceIndex) Parameters:

Reset Network protocols and/or layer.

node

- Pointer to node. - Interface index.

interfaceIndex

Returns:
void

- None

NETWORK_AddResetFunctionList

void NETWORK_AddResetFunctionList (Node* node, int interfaceIndex) Parameters:

Add which protocols to be reset to a fuction list pointer.

node

- Pointer to node. - Interface index.

interfaceIndex

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NETWORK LAYER

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NETWORK LAYER.html[5/24/2011 12:37:59 PM]

NODE

EXata 2.2 API Specification

NODE
This file defines the Node data structure and some generic operations on nodes. Constant / Data Structure Summary Type
STRUCT

Name
Node

This struct includes all the information for a particular node. State information for each layer can be accessed from this structure.
STRUCT NodePositions

Contains information about the initial positions of nodes.

Function / Macro Summary Return Type

void

Summary
NODE_CreateNode(PartitionData* partitionData, NodeId nodeId, int index)

Function used to allocate and initialize a node.

void NODE_ProcessEvent(Node* node, Message* msg)

Function used to call the appropriate layer to execute instructions for the message
void NODE_PrintLocation(Node* node, int coordinateSystemType)

Prints the node's three dimensional coordinates.

TerrainData* NODE_GetTerrainPtr(Node* node)

Get terrainData pointer.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NODE.html[5/24/2011 12:38:08 PM]

NODE

Constant / Data Structure Detail

Structure

Node

Structure

This struct includes all the information for a particular node. State information for each layer can be accessed from this structure. NodePositions

Contains information about the initial positions of nodes.

Function / Macro Detail Function / Macro NODE_CreateNode Format void NODE_CreateNode (PartitionData* partitionData, NodeId nodeId, int index) Parameters: Function used to allocate and initialize a node.
partitionData nodeId index

- the partition that owns the node

- the node's ID

- the node's index within the partition

Returns:
void

- None

NODE_ProcessEvent

void NODE_ProcessEvent (Node* node, Message* msg) Parameters:

Function used to call the appropriate layer to execute instructions for the message

node msg

- node for which message is to be delivered

- message for which instructions are to be executed

Returns:
void

- None

NODE_PrintLocation

void NODE_PrintLocation (Node* node, int coordinateSystemType) Parameters:

Prints the node's three dimensional

node

- the node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NODE.html[5/24/2011 12:38:08 PM]

NODE

coordinates.
coordinateSystemType

- Cartesian or LatLonAlt

Returns:
void

- None

NODE_GetTerrainPtr

TerrainData* NODE_GetTerrainPtr (Node* node) Parameters:

Get terrainData pointer.

node

- the node

Returns:
TerrainData*

- TerrainData pointer

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/NODE.html[5/24/2011 12:38:08 PM]

PARALLEL

EXata 2.2 API Specification

PARALLEL
This file describes data structures and functions used for parallel programming. Constant / Data Structure Summary Type
CONSTANT

Name
MAX_THREADS

The maximum number of processes that can be used in parallel QualNet. Customers do not receive parallel.cpp, so cannot effectively change this value.
ENUMERATION SynchronizationAlgorithm

Possible algorithms to use in the parallel runtime. Synchronous is used by default.

STRUCT LookaheadLocator

This struct is allows us to be able to remove from the LookaheadCalculator's heap. This way lookahead handles can request they be removed. Internally, as the heap re-heapifies these locators are updated.
STRUCT EotHeapElement

Basic data structure for simplifying lookahead calculation.

STRUCT LookaheadCalculator

Stores a heap of EOT elements to calculate lookahead.

Function / Macro Summary Return Type

LookaheadHandle

Summary
PARALLEL_AllocateLookaheadHandle(Node* node)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

Obtains a new lookahead handle that allows a protocol to indicate minimum delay values for output. This minimum delay is called EOT - earliest output time.
void PARALLEL_AddLookaheadHandleToLookaheadCalculator(Node* node, LookaheadHandle lookaheadHandle, clocktype eotOfNode)

Adds a new LookaheadHandle to the lookahead calculator.

void PARALLEL_SetLookaheadHandleEOT(Node* node, LookaheadHandle lookaheadHandle, clocktype eot)

Protocols that use EOT will make use of this function more than any other to update the earliest output time as the simulation progresses. Use of EOT is an all-or-nothing option. If your protocol uses EOT, it _must_ use EOT pervasively.
void PARALLEL_RemoveLookaheadHandleFromLookaheadCalculator(Node* node, LookaheadHandle lookaheadHandle, clocktype* eotOfNode)

Removes a LookaheadHandle from the lookahead calculator.

void PARALLEL_SetMinimumLookaheadForInterface(Node* node, clocktype minLookahead)

Sets a minimum delay for messages going out on this interface. This is typically set by the protocol running on that interface.
void PARALLEL_InitLookaheadCalculator(LookaheadCalculator lookaheadCalculator)

Initializes lookahead calculation. For kernel use only.

int PARALLEL_AssignNodesToPartitions(int numNodes, int numberOfPartitions, NodeInput* nodeInput, NodePosition* nodePos, AddressMapType* map)

Using their positions or other information, assigns each node to a partition. For kernel use only.
int PARALLEL_GetPartitionForNode(NodeId nodeId)

Allows parallel code to determine to what partition a node is assigned. If a Node* is available, it's much quicker to just look it up directly
void PARALLEL_InitializeParallelRuntime(int numberOfThreads)

Sets global variables and stuff. For kernel use only.

void PARALLEL_CreatePartitionThreads(int numberOfThreads, NodeInput* nodeInput, PartitionData* partitionArray)

Creates the threads for parallel execution and starts them running. For kernel use only.
void PARALLEL_GetRemoteMessages(PartitionData* partitionData)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

Collects all the messages received from other partitions. For kernel use only.
void PARALLEL_GetRemoteMessagesAndBarrier(PartitionData* partitionData)

Collects all the messages received from other partitions. This function also acts as a barrier. For kernel use only.
PARALLEL_SendRemoteMessages(Message* msgList, PartitionData* partitionData, int partitionId)

Sends one or more messages to a remote partition. For kernel use only.
PARALLEL_DeliverRemoteMessages(PartitionData* partitionData)

Delivers cached messages to all remote partitions. For kernel use only.
void PARALLEL_SendRemoteMessagesOob(Message* msgList, PartitionData* partitionData, int partitionId, bool isResponse)

Sends one or more messages to a remote partition. These messages are oob messages and will be processed immediately. For kernel use only.
void PARALLEL_SendMessageToAllPartitions(Message* msg, PartitionData* partitionData, bool freeMsg)

Sends a message to all remote partitions, but not the current one. By default, duplicates will be sent to all remote partitions and the original freed, but if freeMsg is false, the original message will not be freed.
PARALLEL_SendRemoteLinkMessage(Node* node, Message* msg, LinkData* link, clocktype txDelay)

Sends one LINK message to a remote partition.

void PARALLEL_UpdateSafeTime(PartitionData* partitionData)

A generic function for calculating the window of safe events For kernel use only.
clocktype PARALLEL_ReturnEarliestGlobalEventTime(PartitionData* partitionData)

Returns the earliest global event time. Required for interfacing to time-sensitive external programs. For kernel use only.
void PARALLEL_Exit(PartitionData* partitionData)

Exits from the parallel system, killing threads, etc. For kernel use only.
void PARALLEL_SetProtocolIsNotEOTCapable(Node* node)

Currently, EOT can only be used if supported by all protocols running in the scenario. If any protocol is not capable, only the minimum lookahead is used.
void PARALLEL_EnableDynamicMobility()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

Forces the runtime to consider mobility events when calculating EOT/ECOT. Mobility events are ignored by default. This function should be called during the initialization of models where changes in position or direction of one node may affect the behavior of other nodes.
void PARALLEL_SetGreedy(bool greedy)

Tells the kernel to use spin locks on barriers if true, or to use blocking barriers otherwise. In greedy mode, the Simulator needs a dedicated CPU per partition.
bool PARALLEL_IsGreedy()

Checks whether SetGreedy has been called.

void PARALLEL_PreFlight(PartitionData* partitionData)

Initializes parallel operation.

void PARALLEL_ScheduleMessagesOnPartition(PartitionData* partitionData, Message* msgList, Message** oobMessage, bool* gotOobMessage, bool isMT)

Takes a list of messages or an OOB message and schedules them for execution on the current partition. Typically these messages have arrived from a remote partition.
void PARALLEL_EndSimulation(PartitionData* partitionData)

Shuts down the parallel engine, including whatever synchronization is required.

void PARALLEL_BuildStatFile(int numPartitions, char* statFileName, char* experimentPrefix)

Builds the final stat file when running in parallel node. Should only be called once from partition 0.
void PARALLEL_NumberOfSynchronizations()

Return the number of synchronizations performed per partition

void PARALLEL_StartRealTimeThread(PartitionData* partitionData)

Tells the kernel to use an independent thread to constantly update realtime.

Constant / Data Structure Detail

Constant

MAX_THREADS 512

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

Enumeration

The maximum number of processes that can be used in parallel QualNet. Customers do not receive parallel.cpp, so cannot effectively change this value. SynchronizationAlgorithm

Structure

Possible algorithms to use in the parallel runtime. Synchronous is used by default. LookaheadLocator

Structure

Basic data structure for simplifying lookahead calculation. LookaheadCalculator

Stores a heap of EOT elements to calculate lookahead.

Function / Macro Detail Function / Macro PARALLEL_AllocateLookaheadHandle Format LookaheadHandle PARALLEL_AllocateLookaheadHandle (Node* node) Parameters: Obtains a new lookahead handle that allows a protocol to indicate minimum delay values for output. This minimum delay is called EOT earliest output time.
node

- the active node

Returns:
LookaheadHandle

- Returns a reference to the node's lookahead data.

PARALLEL_SetMinimumLookaheadForInterface

void PARALLEL_SetMinimumLookaheadForInterface (Node* node, clocktype minLookahead) Parameters:

Sets a minimum delay for messages going out on this interface. This is typically set by the protocol running on that interface.

node

- the active node - the protocol's minimum lookahead

minLookahead

Returns:
void

- None

PARALLEL_InitLookaheadCalculator

void PARALLEL_InitLookaheadCalculator (LookaheadCalculator lookaheadCalculator) Parameters:

Initializes lookahead calculation. For kernel use only.

lookaheadCalculator

- the lookahead calculator

Returns:
void
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

- None

PARALLEL

PARALLEL_AssignNodesToPartitions

int PARALLEL_AssignNodesToPartitions (int numNodes, int numberOfPartitions, NodeInput* nodeInput, NodePosition* nodePos, AddressMapType* map) Parameters:

Using their positions or other information, assigns each node to a partition. For kernel use only.

numNodes

- the number of nodes - the number of partitions

numberOfPartitions nodeInput nodePos map

- the input configuration file

- the node positions

- node ID <--> IP address mappings

Returns:
int

- the number of partitions used

PARALLEL_GetPartitionForNode

int PARALLEL_GetPartitionForNode (NodeId nodeId) Parameters:

Allows parallel code to determine to what partition a node is assigned. If a Node* is available, it's much quicker to just look it up directly

nodeId

- the node's ID

Returns:
int

- the partition to which the node is assigned

PARALLEL_InitializeParallelRuntime

void PARALLEL_InitializeParallelRuntime (int numberOfThreads) Parameters:

Sets global variables and stuff. For kernel use only.

numberOfThreads

- the number of processors to use.

Returns:
void

- None

PARALLEL_CreatePartitionThreads

void PARALLEL_CreatePartitionThreads (int numberOfThreads, NodeInput* nodeInput, PartitionData* partitionArray) Parameters:

Creates the threads for parallel execution and starts them running. For kernel use only.

numberOfThreads nodeInput

- the number of threads to create.

- the input configuration - an array containing the partition data

partitionArray

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

PARALLEL_GetRemoteMessages

void PARALLEL_GetRemoteMessages (PartitionData* partitionData) Parameters:

Collects all the messages received from other partitions. For kernel use only.

partitionData

- a pointer to the partition

Returns:
void

- None

PARALLEL_GetRemoteMessagesAndBarrier

void PARALLEL_GetRemoteMessagesAndBarrier (PartitionData* partitionData) Parameters:

Collects all the messages received from other partitions. This function also acts as a barrier. For kernel use only.

partitionData

- a pointer to the partition

Returns:
void

- None

PARALLEL_SendRemoteMessages

PARALLEL_SendRemoteMessages (Message* msgList, PartitionData* partitionData, int partitionId) Parameters:

Sends one or more messages to a remote partition. For kernel use only.

msgList

- a linked list of Messages - a pointer to the partition

partitionData partitionId

- the partition's ID

Returns: - None PARALLEL_DeliverRemoteMessages PARALLEL_DeliverRemoteMessages (PartitionData* partitionData) Parameters: Delivers cached messages to all remote partitions. For kernel use only.
partitionData

- a pointer to the partition

Returns: - None PARALLEL_SendRemoteMessagesOob void PARALLEL_SendRemoteMessagesOob (Message* msgList, PartitionData* partitionData, int partitionId, bool isResponse) Parameters: Sends one or more messages to a remote partition. These messages are oob messages and will be processed immediately. For kernel use only.
msgList

- a linked list of Messages - a pointer to the partition

partitionData partitionId

- the partition's ID

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

isResponse

- if it's a response to an OOB message

Returns:
void

- None

PARALLEL_SendMessageToAllPartitions

void PARALLEL_SendMessageToAllPartitions (Message* msg, PartitionData* partitionData, bool freeMsg) Parameters:

msg

- the message(s) to send - the sending partition

partitionData freeMsg

- whether or not to free the original

Returns:
void

- None

PARALLEL_SendRemoteLinkMessage

PARALLEL_SendRemoteLinkMessage (Node* node, Message* msg, LinkData* link, clocktype txDelay) Parameters:

Sends one LINK message to a remote partition.

node msg

- the sending node

- the message to be sent - info about the link - the transmission delay, not including propagation

link

txDelay

Returns: - None PARALLEL_UpdateSafeTime void PARALLEL_UpdateSafeTime (PartitionData* partitionData) Parameters: A generic function for calculating the window of safe events For kernel use only.
partitionData

- a pointer to the partition

Returns:
void

- None

PARALLEL_ReturnEarliestGlobalEventTime

clocktype PARALLEL_ReturnEarliestGlobalEventTime (PartitionData* partitionData) Parameters:

Returns the earliest global event time. Required for interfacing to timesensitive external programs. For kernel use only.
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

partitionData

- a pointer to the partition

Returns:

PARALLEL

Tells the kernel to use spin locks on barriers if true, or to use blocking barriers otherwise. In greedy mode, the Simulator needs a dedicated CPU per partition.

greedy

- should it be greedy or not?

Returns:
void

- None

PARALLEL_IsGreedy

bool PARALLEL_IsGreedy () Parameters:

Checks whether SetGreedy has been called.

Returns:
bool

- true if greedy mode is enabled.

PARALLEL_PreFlight

void PARALLEL_PreFlight (PartitionData* partitionData) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

Initializes parallel operation.

partitionData

- the partition to initialize.

Returns:
void

- None

PARALLEL_ScheduleMessagesOnPartition

void PARALLEL_ScheduleMessagesOnPartition (PartitionData* partitionData, Message* msgList, Message** oobMessage, bool* gotOobMessage, bool isMT) Parameters:

Takes a list of messages or an OOB message and schedules them for execution on the current partition. Typically these messages have arrived from a remote partition.

partitionData msgList

- the partition.

- a list of normal simulation messages. - an out of bounds message. - returns true if Oob response is received

oobMessage

gotOobMessage isMT

- is this called from a worker thread

Returns:
void

- None

PARALLEL_EndSimulation

void PARALLEL_EndSimulation (PartitionData* partitionData) Parameters:

Shuts down the parallel engine, including whatever synchronization is required.

partitionData

- the partition to terminate.

Returns:
void

- None

PARALLEL_BuildStatFile

void PARALLEL_BuildStatFile (int numPartitions, char* statFileName, char* experimentPrefix) Parameters:

Builds the final stat file when running in parallel node. Should only be called once from partition 0.

numPartitions statFileName

- number of partitions

- name of stat file - experiment prefix

experimentPrefix

Returns:
void

- None

PARALLEL_NumberOfSynchronizations

void PARALLEL_NumberOfSynchronizations () Parameters:

Return the number of synchronizations performed per partition

Returns:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARALLEL

void

- None

PARALLEL_StartRealTimeThread

void PARALLEL_StartRealTimeThread (PartitionData* partitionData) Parameters:

Tells the kernel to use an independent thread to constantly update realtime.

partitionData

- a pointer to the partition

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARALLEL.html[5/24/2011 12:38:24 PM]

PARTITION

EXata 2.2 API Specification

PARTITION
This file contains declarations of some functions for partition threads. Constant / Data Structure Summary Type
CONSTANT

Name
NUM_SIM_TIME_STATUS_PRINTS

The number of percentage complete statements to print

CONSTANT COMMUNICATION_ID_INVALID

A default unitialized communication ID.

CONSTANT COMMUNICATION_DELAY_REAL_TIME

A value to indicate real time interpartition communication

STRUCT SubnetMemberData

Data structure containing interfaceIndex and Node* for a node in a single subnet
STRUCT PartitionSubnetMemberList

Data structure containing member data info for all nodes in a single subnet
STRUCT PartitionSubnetData

Data structure containing subnet member data for all subnets

STRUCT PartitionData

Contains global information for this partition.

STRUCT SimulationProperties

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Global properties of the simulation for all partitions.

Function / Macro Summary Return Type

void

Summary
PARTITION_GetTerrainPtr(PartitionData* partitionData)

Inline function used to get terrainData pointer.

void PARTITION_CreateEmptyPartition(int partitionId, int numPartitions)

Function used to allocate and perform inititlaization of of an empty partition data structure.
void PARTITION_InitializePartition(PartitionData* partitionData, TerrainData* terrainData, clocktype maxSimClock, double startRealTime, int numNodes, BOOL traceEnabled, AddressMapType* addressMapPtr, NodePositions* nodePositions, NodeInput* nodeInput, int seedVal, int* nodePlacementTypeCounts, char* experimentPrefix, clocktype startSimClock)

Function used to initialize a partition.

void PARTITION_InitializeNodes(PartitionData* partitionData)

Function used to allocate and initialize the nodes on a partition.

void PARTITION_Finalize(PartitionData* partitionData)

Finalizes the nodes on the partition.

void PARTITION_ProcessPartition(PartitionData* partitionData)

Creates and initializes the nodes, then processes events on this partition.
void PARTITION_ProcessSendMT(PartitionData* partitionData)

Messages sent by worker threads outside of the main simulation event loop MUST call MESSAGE_SendMT (). This funciton then is the other half - where the multi-thread messages are properly added to the event list.
BOOL PARTITION_ReturnNodePointer(PartitionData* partitionData, Node** node, NodeId nodeId, BOOL remoteOK)

Returns a pointer to the node or NULL if the node is not on this partition. If remoteOK is TRUE, returns a pointer to this partition's proxy for a remote node if the node does not belong to this partition. This feature should be used with great care, as the proxy is incomplete. Returns TRUE if the node is local.
void PARTITION_NodeExists(PartitionData* partitionData, NodeId nodeId)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Determines whether the node ID exists in the scenario. Must follow node creation.
void PARTITION_PrintRunTimeStats(PartitionData* partitionData)

If dynamic statistics reporting is enabled, generates statistics for enabled layers.

void PARTITION_SchedulePartitionEvent(PartitionData* partitionData, Message* msg, clocktype eventTime)

Schedules a generic partition-level event.

void PARTITION_HandlePartitionEvent(PartitionData* partitionData, Message* msg)

An empty function for protocols to use that need to schedule and handle partition-level events.
void PARTITION_ClientStateSet(PartitionData* partitionData, const char* stateName, void* clientState)

Sets or replaces a pointer to client-state, identifed by name, in the indicated partition. Allows client code, like external iterfaces, to store their own data in the partition. The client's state pointer is set and found by name. If the caller passes a name for client state that is already being stored, the state pointer replaces what was already there.
void* PARTITION_ClientStateFind(PartitionData* partitionData, const char* stateName)

Looks up the requested client-state by name. Returns NULL if the state isn't present.
CommunicatorId PARTITION_COMMUNICATION_RegisterCommunicator(PartitionData* partitionData, const char* name, PartitionCommunicationHandler handler)

Allocates a message id and registers the handler that will be invoked to receive callbacks when messages are with the id are sent.
CommunicatorId PARTITION_COMMUNICATION_FindCommunicator(PartitionData* partitionData, std name)

Locate an already registered commincator.

void PARTITION_COMMUNICATION_SendToPartition(PartitionData* partitionData, int partitionId, Message* msg, clocktype delay)

Transmit a message to a partition.

void PARTITION_COMMUNICATION_SendToAllPartitions(PartitionData* partitionData, Message* msg, clocktype delay)

Transmit a message to all partitions.

std IO_Return_Qualnet_Directory()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

This will return in a string the current directory qualnet is executing from
boolean true/false if file exists IO_SourceFileExists()

This will return a boolean true if file exists, and false if not
std IO_CheckSourceLibrary()

This will return in a string the formatted yes/no line for whether the fingerprint file exists for given library
std IO_ReturnSourceAndCompiledLibraries()

This will return in a string a list of libraries currently compiled into product as well as those which have source code available.
std IO_ReturnExpirationDateFromLicenseFeature()

This will return in a string a list of libraries currently compiled into product as well as those which have source code available.
std IO_ReturnExpirationDateFromNumericalDate()

This will return in a string the expiration date of the library

std IO_ReturnExpirationDateFromNumericalDate()

This will return in a string the expiration date of the library

UInt64 containing the date IO_ParseFlexLMDate()

Parse a FlexLM date in a platform safe way

std IO_ReturnStatusMessageFromLibraryInfo()

This will return in a string the status message for the library used with the -print_libraries option
std IO_ReturnStatusMessageFromLibraryInfo()

This will return in a string the library name from its index :: because flexlm won't allow std strucsts in main.cpp :: but main.cpp is the only place flex structs are allowed
PARTITION_ShowProgress()

Print standard QualNet progress log

Data structure containing interfaceIndex and Node* for a node in a single subnet PartitionSubnetMemberList

Structure

Data structure containing member data info for all nodes in a single subnet PartitionSubnetData

Structure

Data structure containing subnet member data for all subnets PartitionData

Structure

Contains global information for this partition. SimulationProperties

Global properties of the simulation for all partitions.

Function / Macro Detail Function / Macro PARTITION_GetTerrainPtr Format void PARTITION_GetTerrainPtr (PartitionData* partitionData)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Parameters: Inline function used to get terrainData pointer.

partitionData

- pointer to partitionData

Returns:
void

- None

PARTITION_CreateEmptyPartition

void PARTITION_CreateEmptyPartition (int partitionId, int numPartitions) Parameters:

Function used to allocate and perform inititlaization of of an empty partition data structure.

partitionId

- the partition ID, used for parallel - for parallel

numPartitions

Returns:
void

- None

PARTITION_InitializePartition

Function used to initialize a partition.

void PARTITION_InitializePartition (PartitionData* partitionData, TerrainData* terrainData, clocktype maxSimClock, double startRealTime, int numNodes, BOOL traceEnabled, AddressMapType* addressMapPtr, NodePositions* nodePositions, NodeInput* nodeInput, int seedVal, int* nodePlacementTypeCounts, char* experimentPrefix, clocktype startSimClock) Parameters:
partitionData terrainData maxSimClock

- an empty partition data structure

- dimensions, terrain database, etc. - length of the scenario - for synchronizing with the realtime

startRealTime numNodes

- number of nodes in the simulation - is packet tracing enabled? - contains Node ID <--> IP address mappings - initial node locations and partition assignments

traceEnabled

addressMapPtr nodePositions nodeInput seedVal

- contains all the input parameters

- the global random seed - gives information about node placemt

nodePlacementTypeCounts experimentPrefix startSimClock

void PARTITION_ProcessPartition (PartitionData* partitionData) Parameters:

Creates and initializes the nodes, then processes events on this partition.

partitionData

- an pre-initialized partition data structure

Returns:
void

- None

PARTITION_ProcessSendMT

void PARTITION_ProcessSendMT (PartitionData* partitionData) Parameters:

partitionData

- an pre-initialized partition data structure

Returns:
void

- None

BOOL PARTITION_ReturnNodePointer (PartitionData* partitionData, Node** node, NodeId nodeId, BOOL remoteOK) Parameters:

partitionData node

- an pre-initialized partition data structure

- for returning the node pointer - the node's ID - is it ok to return a pointer to proxy node?

nodeId

remoteOK
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Returns:
BOOL

- returns TRUE if the node is local to this partition

PARTITION_NodeExists

void PARTITION_NodeExists (PartitionData* partitionData, NodeId nodeId) Parameters:

Determines whether the node ID exists in the scenario. Must follow node creation.

partitionData nodeId

- an pre-initialized partition data structure

- the node's ID

Returns:
void

- None

PARTITION_PrintRunTimeStats

void PARTITION_PrintRunTimeStats (PartitionData* partitionData) Parameters:

If dynamic statistics reporting is enabled, generates statistics for enabled layers.

partitionData

- an pre-initialized partition data structure

Returns:
void

- None

PARTITION_SchedulePartitionEvent

void PARTITION_SchedulePartitionEvent (PartitionData* partitionData, Message* msg, clocktype eventTime) Parameters:

Schedules a generic partition-level event.

partitionData msg

- an pre-initialized partition data structure

- an event - the time the event should occur

Returns:
void*

- returns the client state

PARTITION_COMMUNICATION_RegisterCommunicator

CommunicatorId PARTITION_COMMUNICATION_RegisterCommunicator (PartitionData* partitionData, const char* name, PartitionCommunicationHandler handler) Parameters:

Allocates a message id and registers the handler that will be invoked to receive callbacks when messages are with the id are sent.

partitionData name

- an pre-initialized partition data structure

- Your name for this type of message. - Function

handler

Returns:
CommunicatorId

- used to later when calling MESSAGE_Alloc().

PARTITION_COMMUNICATION_FindCommunicator

CommunicatorId PARTITION_COMMUNICATION_FindCommunicator (PartitionData* partitionData, std name) Parameters:

Locate an already registered commincator.

partitionData name

- an pre-initialized partition data structure

- string

Returns:
CommunicatorId

- found communicator Id or COMMUNICATION_ID_INVALID if not found.

PARTITION_COMMUNICATION_SendToPartition

void PARTITION_COMMUNICATION_SendToPartition (PartitionData* partitionData, int partitionId, Message* msg, clocktype delay)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Parameters: Transmit a message to a partition.

partitionData partitionId msg

- an pre-initialized partition data structure

- partition to send the message to

- Message to send. You are required to follow - When the message should execute. Special delay

delay

Returns:
void

- None

PARTITION_COMMUNICATION_SendToAllPartitions

void PARTITION_COMMUNICATION_SendToAllPartitions (PartitionData* partitionData, Message* msg, clocktype delay) Parameters:

Transmit a message to all partitions.

partitionData msg

- an pre-initialized partition data structure

- Message to send. You are required to follow - When the message should execute. Special delay

delay

Returns:
void

- None

IO_Return_Qualnet_Directory

std IO_Return_Qualnet_Directory () Parameters:

This will return in a string the current directory qualnet is executing from IO_SourceFileExists

Returns:
std

- string containing current qualnet directory

boolean true/false if file exists IO_SourceFileExists () Parameters:

This will return a boolean true if file exists, and false if not

Returns:
boolean true/false if file exists

- None

IO_CheckSourceLibrary

std IO_CheckSourceLibrary () Parameters:

This will return in a string the formatted yes/no line for whether the fingerprint file exists for given library IO_ReturnSourceAndCompiledLibraries

Returns:
std

- string containing list of libraries

std IO_ReturnSourceAndCompiledLibraries ()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

Parameters: This will return in a string a list of libraries currently compiled into product as well as those which have source code available. IO_ReturnExpirationDateFromLicenseFeature Returns:
std

- string containing list of libraries

std IO_ReturnExpirationDateFromLicenseFeature () Parameters:

This will return in a string a list of libraries currently compiled into product as well as those which have source code available. IO_ReturnExpirationDateFromNumericalDate

Returns:
std

- string containing expiration date for this feature

std IO_ReturnExpirationDateFromNumericalDate () Parameters:

This will return in a string the expiration date of the library

Returns:
std

- string containing expiration date for this feature

IO_ReturnExpirationDateFromNumericalDate

std IO_ReturnExpirationDateFromNumericalDate () Parameters:

This will return in a string the expiration date of the library

Returns:
std

- string containing expiration date for this feature

IO_ParseFlexLMDate

UInt64 containing the date IO_ParseFlexLMDate () Parameters:

Parse a FlexLM date in a platform safe way

Returns:
UInt64 containing the date

- None

IO_ReturnStatusMessageFromLibraryInfo

std IO_ReturnStatusMessageFromLibraryInfo () Parameters:

This will return in a string the status message for the library used with the -print_libraries option IO_ReturnStatusMessageFromLibraryInfo

Returns:
std

- string containing status message for libary

std IO_ReturnStatusMessageFromLibraryInfo () Parameters:

This will return in a string the library name from its index :: because flexlm won't allow std strucsts in main.cpp :: but main.cpp is the only place flex structs are allowed

Returns:
std

- string containing library name

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PARTITION

PARTITION_ShowProgress

PARTITION_ShowProgress () Parameters:

Print standard QualNet progress log

Returns: -

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PARTITION.html[5/24/2011 12:38:41 PM]

PHYSICAL LAYER

EXata 2.2 API Specification

PHYSICAL LAYER
This file describes data structures and functions used by the Physical Layer. Most of this functionality is enabled/used in the Wireless library. Constant / Data Structure Summary Type
CONSTANT

Name
PHY_DEFAULT_NOISE_FACTORPHY_DEFAULT_NOISE_FACTOR

Default noise factor in physical medium

CONSTANT PHY_DEFAULT_TEMPERATUREPHY_DEFAULT_TEMPERATURE

Default temperature of physical medium.

CONSTANT PHY_DEFAULT_MIN_PCOM_VALUE

Default minimum pcom value threshold

CONSTANT PHY_DEFAULT_SYNC_COLLISION_WINDOW

Default minimum pcom value threshold

ENUMERATION PhyModel

Different phy types supported.

ENUMERATION PhyRxModel

Different types of packet reception model

STRUCT PhyBerEntry

SNR/BER curve entry

STRUCT PhyBerTable

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Bit Error Rate table.

STRUCT PhyPerEntry

SNR/PER curve entry

STRUCT PhyPerTable

Packet Error Rate table.

STRUCT PhySerEntry

SNR/PER curve entry

STRUCT PhySerTable

Symbol Error Rate table.

STRUCT PhySignalMeasurement

Measurement of the signal of received pkt

STRUCT AntennaModel

Structure for classifying different types of antennas.

STRUCT AntennaOmnidirectional

Structure for an omnidirectional antenna.

STRUCT PhyPcomItem

Used by Phy layer to store PCOM values

STRUCT PhyData

Structure for phy layer

STRUCT PacketPhyStatus

Used by Phy layer to report channel status to mac layer

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Function / Macro Summary Return Type

void

Summary
PHY_GlobalBerInit(const NodeInput* nodeInput)

Pre-load all the BER files.

void PHY_GetSnrBerTableByName(char* tableName)

Get a pointer to a specific BER table.

int PHY_GetSnrBerTableIndex(Node* node, int phyIndex)

Get a index of BER table used by PHY.

int PHY_SetSnrBerTableIndex(Node* node, int phyIndex)

Set index of BER table to be used by PHY.

void PHY_GlobalPerInit(const NodeInput* nodeInput)

Pre-load all the PER files.

void PHY_GetSnrPerTableByName(char* tableName)

Get a pointer to a specific PER table.

void PHY_GlobalSerInit(const NodeInput* nodeInput)

Pre-load all the SER files.

void PHY_GetSnrSerTableByName(char* tableName)

Get a pointer to a specific SER table.

void PHY_Init(Node* node, const NodeInput* nodeInput)

Initialize physical layer

void PHY_CreateAPhyForMac(Node* node, const NodeInput* nodeInput, int interfaceIndex, int networkAddress, PhyModel phyModel, int* phyNumber)

Initialization function for the phy layer

void PHY_Finalize(Node * node)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Called at the end of simulation to collect the results of the simulation of the Phy Layer.
void PHY_ProcessEvent(Node* node, Message* msg)

Models the behaviour of the Phy Layer on receiving the message encapsulated in msgHdr
PhyStatusType PHY_GetStatus(Node * node, int phyNum)

Retrieves the Phy's current status

void PHY_SetTransmitPower(Node * node, int phyIndex, double newTxPower_mW)

Sets the Radio's transmit power in mW

void PHY_SetRxSNRThreshold(Node * node, int phyIndex, double snr)

Sets the Radio's Rx SNR Threshold

void PHY_SetDataRate(Node * node, int phyIndex, int dataRate)

Sets the Radio's Data Rate for both Tx and Rx

void PHY_SetTxDataRate(Node * node, int phyIndex, int dataRate)

For radios that support different Tx and Rx data rates, this will set the Rx Data Rate. For others, it will call PHY_SetDataRate.
void PHY_SetRxDataRate(Node * node, int phyIndex, int dataRate)

For radios that support different Tx and Rx data rates, this will set the Rx Data Rate. For others, it will call PHY_SetDataRate.
void PHY_GetTransmitPower(Node * node, int phyIndex, double* txPower_mW)

Gets the Radio's transmit power in mW.

clocktype PHY_GetTransmissionDelay(Node * node, int phyIndex, int size)

Get transmission delay based on the first (usually lowest) data rate WARNING: This function call is to be replaced with PHY_GetTransmissionDuration() with an appropriate data rate
clocktype PHY_GetTransmissionDuration(Node * node, int phyIndex, int dataRateIndex, int size)

Get transmission duration of a structured signal fragment.

PhyModel PHY_GetFrameModel(Node * node, int phyNum)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Get Physical Model

PhyModel PHY_GetAntennaModelType(Node * node, int phyNum)

Get Antenna Model type

void PHY_StartTransmittingSignal(Node * node, int phyNum, Message* msg, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne)

Starts transmitting a packet.

void PHY_StartTransmittingSignal(Node * node, int phyNum, Message* msg, clocktype duration, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne)

Starts transmitting a packet. Function is being overloaded

void PHY_StartTransmittingSignal(Node * node, int phyNum, Message* msg, int bitSize, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne)

Starts transmitting a packet.

void PHY_SignalArrivalFromChannel(Node * node, int phyIndex, int channelIndex, PropRxInfo* propRxInfo)

Called when a new signal arrives

void PHY_SignalEndFromChannel(Node * node, int phyIndex, int channelIndex, PropRxInfo* propRxInfo)

Called when the current signal ends

int PHY_GetTxDataRate(Node * node, int phyIndex)

Get transmission data rate

int PHY_GetRxDataRate(Node * node, int phyIndex)

Get reception data rate

int PHY_GetTxDataRateType(Node * node, int phyIndex)

Get transmission data rate type

int PHY_GetRxDataRateType(Node * node, int phyIndex)

Get reception data rate type

void PHY_SetTxDataRateType(Node * node, int phyIndex, int dataRateType)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Set transmission data rate type

void PHY_GetLowestTxDataRateType(Node* node, int phyIndex, int* dataRateType)

Get the lowest transmission data rate type

void PHY_SetLowestTxDataRateType(Node* node, int phyIndex)

Set the lowest transmission data rate type

void PHY_GetHighestTxDataRateType(Node* node, int phyIndex, int* dataRateType)

Get the highest transmission data rate type

void PHY_SetHighestTxDataRateType(Node* node, int phyIndex)

Set the highest transmission data rate type

void PHY_GetHighestTxDataRateTypeForBC(Node* node, int phyIndex, int* dataRateType)

Get the highest transmission data rate type for broadcast

void PHY_SetHighestTxDataRateTypeForBC(Node* node, int phyIndex)

Set the highest transmission data rate type for broadcast

double PHY_ComputeSINR(PhyData * phyData, double * signalPower_mW, double* interferencePower_mW, int bandwidth)

Compute SINR
void PHY_SignalInterference(Node* node, int phyIndex, int channelIndex, Message * msg, double * signalPower_mW, double* interferencePower_mW)

Compute Power from the desired signal and interference

double PHY_BER(PhyData * phyData, int berTableIndex, double sinr)

Get BER
double PHY_SER(PhyData * phyData, int perTableIndex, double sinr)

Get SER
void PHY_StopListeningToChannel(Node* node, int phyIndex, int channelIndex)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

BOOL

PHY_CanListenToChannel(Node* node, int phyIndex, int channelIndex)

Check if it can listen to the channel

BOOL PHY_IsListeningToChannel(Node* node, int phyIndex, int channelIndex)

Check if it is listening to the channel

void PHY_SetTransmissionChannel(Node* node, int phyIndex, int channelIndex)

Set the channel index used for transmission

void PHY_GetTransmissionChannel(Node* node, int phyIndex, int channelIndex)

Get the channel index used for transmission

BOOL PHY_MediumIsIdle(Node* node, int phyNum)

Check if the medium is idle

BOOL PHY_MediumIsIdleInDirection(Node* node, int phyNum, double azimuth)

Check if the medium is idle if sensed directionally

void PHY_SetSensingDirection(Node* node, int phyNum, double azimuth)

Set the sensing direction

void PHY_StartTransmittingSignalDirectionally(Node* node, int phyNum, Message* msg, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne, double directionAzimuth)

Start transmitting a signal directionally

void PHY_LockAntennaDirection(Node* node, int phyNum)

Lock the direction of antenna

void PHY_UnlockAntennaDirection(Node* node, int phyNum)

Unlock the direction of antenna

double PHY_GetLastSignalsAngleOfArrival(Node* node, int phyNum)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Get the AOA of the last signal

void PHY_TerminateCurrentReceive(Node* node, int phyNum, const BOOL terminateOnlyOnReceiveError, BOOL* receiveError, clocktype* endSignalTime)

Terminate the current signal reception

double PHY_PropagationRange(Node* txnode, Node* node, int txInterfaceIndex, int interfaceIndex, int channnelIndex, BOOL printAll)

Calculates an estimated radio range for the PHY. Supports only TWO-RAY and FREE-SPACE.
void ENERGY_Init(Node* node, const int phyIndex, NodeInput* nodeInput)

This function declares energy model variables and initializes them. Moreover, the function read energy model specifications and configures the parameters which are configurable.
void ENERGY_PrintStats(Node* node, const int phyIndex)

To print the statistic of Energy Model.

void Phy_ReportStatusToEnergyModel(Node* node, const int phyIndex, PhyStatusType prevStatus, PhyStatusType newStatus)

This function should be called whenever a state transition occurs in any place in PHY layer. As input parameters, the function reads the current state and the new state of PHY layer and based on the new sates calculates the cost of the load that should be taken off the battery. The function then interacts with battery model and updates the charge of battery.
void Generic_UpdateCurrentLoad(Node* node, const int phyIndex)

To update the current load of generic energy model.

void PHY_GetSteeringAngle(Node* node, int phyIndex)

Gets the current steering angle for a directional antenna from PHY models that support this.
void PHY_CheckPacketPhyDrop(PartitionData* partition, PropChannel* propChannel, int numNodes, int channelIndex, Message* msg)

This function is for Stats DB. It is to check whether need to record a drop event.

Constant / Data Structure Detail

Constant

PHY_DEFAULT_NOISE_FACTORPHY_DEFAULT_NOISE_FACTOR 10.0

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Structure

Structure for phy layer PacketPhyStatus

Used by Phy layer to report channel status to mac layer

Function / Macro Detail Function / Macro PHY_GlobalBerInit Format void PHY_GlobalBerInit (const NodeInput* nodeInput) Parameters: Pre-load all the BER files.
nodeInput

- structure containing contents of input file

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

PHY_GetSnrBerTableByName

void PHY_GetSnrBerTableByName (char* tableName) Parameters:

Get a pointer to a specific BER table.

tableName

- name of the BER file

Returns:
void

- None

PHY_GetSnrBerTableIndex

int PHY_GetSnrBerTableIndex (Node* node, int phyIndex) Parameters:

Get a index of BER table used by PHY.

node

- Node pointer - interface Index

phyIndex

Returns:
int

- None

PHY_SetSnrBerTableIndex

int PHY_SetSnrBerTableIndex (Node* node, int phyIndex) Parameters:

Set index of BER table to be used by PHY.

node

- Node pointer - interface Index

void PHY_CreateAPhyForMac (Node* node, const NodeInput* nodeInput, int interfaceIndex, int networkAddress, PhyModel phyModel, int* phyNumber) Parameters:

Initialization function for the phy layer

node

- node being initialized - structure containing contents of input file - interface being initialized. - address of the interface.

nodeInput

interfaceIndex networkAddress phyModel

- Which phisical model is used. - returned value to be used as phyIndex

phyNumber

Returns:
void

- None

PHY_Finalize

void PHY_Finalize (Node * node) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Called at the end of simulation to collect the results of the simulation of the Phy Layer.

node

- node for which results are to be collected

Returns:
void

- None

PHY_ProcessEvent

void PHY_ProcessEvent (Node* node, Message* msg) Parameters:

Models the behaviour of the Phy Layer on receiving the message encapsulated in msgHdr

node msg

- node which received the message

- message received by the layer

Returns:
void

- None

PHY_GetStatus

PhyStatusType PHY_GetStatus (Node * node, int phyNum) Parameters:

Retrieves the Phy's current status

node

- node for which stats are to be collected - interface for which stats are to be collected

phyNum

Returns:
PhyStatusType

- status of interface.

PHY_SetTransmitPower

void PHY_SetTransmitPower (Node * node, int phyIndex, double newTxPower_mW) Parameters:

Sets the Radio's transmit power in mW

node

- node for which transmit power is to be set - interface for which transmit power is to be set - transmit power(mW)

phyIndex

newTxPower_mW

Returns:
void

- None

PHY_SetRxSNRThreshold

void PHY_SetRxSNRThreshold (Node * node, int phyIndex, double snr) Parameters:

Sets the Radio's Rx SNR Threshold

node

- node for which transmit power is to be set - interface for which transmit power is to be set

phyIndex snr

- threshold value to be set

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

phyIndex

txPower_mW

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Returns:
void

- None

PHY_GetTransmissionDelay

clocktype PHY_GetTransmissionDelay (Node * node, int phyIndex, int size) Parameters:

Get transmission delay based on the first (usually lowest) data rate WARNING: This function call is to be replaced with PHY_GetTransmissionDuration() with an appropriate data rate

node

- node pointer to node - interface index

phyIndex size

- size of the frame in bytes

Returns:
clocktype

- transmission delay.

PHY_GetTransmissionDuration

clocktype PHY_GetTransmissionDuration (Node * node, int phyIndex, int dataRateIndex, int size) Parameters:

Get transmission duration of a structured signal fragment.

node

- node pointer to node - interface index. - data rate.

phyIndex

dataRateIndex size

- size of frame in bytes.

Returns:
clocktype

- transmission duration

PHY_GetFrameModel

PhyModel PHY_GetFrameModel (Node * node, int phyNum) Parameters:

Get Physical Model

node

- node pointer to node - interface index

phyNum

Returns:
PhyModel

- Physical Model

PHY_GetAntennaModelType

PhyModel PHY_GetAntennaModelType (Node * node, int phyNum) Parameters:

Get Antenna Model type

node

- node pointer to node - interface index

phyNum

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Returns:
PhyModel

- Physical Model

PHY_StartTransmittingSignal

void PHY_StartTransmittingSignal (Node * node, int phyNum, Message* msg, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne) Parameters:

Starts transmitting a packet.

node

- node pointer to node - interface index

phyNum msg

- packet to be sent - use delay specified by MAC

useMacLayerSpecifiedDelay delayUntilAirborne

- delay until airborne

Returns:
void

- None

PHY_StartTransmittingSignal

void PHY_StartTransmittingSignal (Node * node, int phyNum, Message* msg, clocktype duration, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne) Parameters:

Starts transmitting a packet. Function is being overloaded

node

- node pointer to node - interface index

phyNum msg

- packet to be sent - specified transmission delay - use delay specified by MAC

duration

useMacLayerSpecifiedDelay delayUntilAirborne

- delay until airborne

Returns:
void

- None

PHY_StartTransmittingSignal

void PHY_StartTransmittingSignal (Node * node, int phyNum, Message* msg, int bitSize, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne) Parameters:

Starts transmitting a packet.

node

- node pointer to node - interface index

phyNum msg

- packet to be sent

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

bitSize

- specified size of the packet in bits - use delay specified by MAC

useMacLayerSpecifiedDelay delayUntilAirborne

- delay until airborne

Returns:
void

- None

PHY_SignalArrivalFromChannel

void PHY_SignalArrivalFromChannel (Node * node, int phyIndex, int channelIndex, PropRxInfo* propRxInfo) Parameters:

Called when a new signal arrives

node

- node pointer to node - interface index - channel index

phyIndex

channelIndex propRxInfo

- information on the arrived signal

Returns:
void

- None

PHY_SignalEndFromChannel

void PHY_SignalEndFromChannel (Node * node, int phyIndex, int channelIndex, PropRxInfo* propRxInfo) Parameters:

Called when the current signal ends

node

- node pointer to node - interface index - channel index

phyIndex

channelIndex propRxInfo

- information on the arrived signal

Returns:
void

- None

PHY_GetTxDataRate

int PHY_GetTxDataRate (Node * node, int phyIndex) Parameters:

Get transmission data rate

node

- node pointer to node - interface index

phyIndex

Returns:
int

- None

PHY_GetRxDataRate

int PHY_GetRxDataRate (Node * node, int phyIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHY_GetLowestTxDataRateType

void PHY_GetLowestTxDataRateType (Node* node, int phyIndex, int* dataRateType) Parameters:

Get the lowest transmission data rate type

node

- node pointer to node

PHY_SetHighestTxDataRateType

void PHY_SetHighestTxDataRateType (Node* node, int phyIndex) Parameters:

Set the highest transmission data rate type

node

- node pointer to node - interface index

phyIndex

Returns:
void

- None

PHY_GetHighestTxDataRateTypeForBC

void PHY_GetHighestTxDataRateTypeForBC (Node* node, int phyIndex, int* dataRateType) Parameters:

Get the highest transmission data rate type for broadcast

node

- node pointer to node - interface index - rate of data

phyIndex

dataRateType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Returns:
void

- None

PHY_SetHighestTxDataRateTypeForBC

void PHY_SetHighestTxDataRateTypeForBC (Node* node, int phyIndex) Parameters:

Set the highest transmission data rate type for broadcast

node

- node pointer to node - interface index

phyIndex

Returns:
void

- None

PHY_ComputeSINR

double PHY_ComputeSINR (PhyData * phyData, double * signalPower_mW, double* interferencePower_mW, int bandwidth) Parameters:

Compute SINR

phyData

- PHY layer data - Signal power - Interference power

signalPower_mW

interferencePower_mW bandwidth

- Bandwidth

Returns:
double

- Signal to Interference and Noise Ratio

PHY_SignalInterference

void PHY_SignalInterference (Node* node, int phyIndex, int channelIndex, Message * msg, double * signalPower_mW, double* interferencePower_mW) Parameters:

Compute Power from the desired signal and interference

node

- Node that is being - interface number - channel index

phyIndex

channelIndex msg

- message including desired signal - power from the desired signal - power from interfering signals

signalPower_mW

interferencePower_mW

Returns:
void

- None

PHY_BER

double PHY_BER (PhyData * phyData, int berTableIndex, double sinr)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Parameters: Get BER

phyData

- PHY layer data - index for BER tables

berTableIndex sinr

- Signal to Interference and Noise Ratio

Returns:
double

- Bit Error Rate

PHY_SER

double PHY_SER (PhyData * phyData, int perTableIndex, double sinr) Parameters:

Get SER

phyData

- PHY layer data - index for SER tables

perTableIndex sinr

- Signal to Interference and Noise Ratio

Returns:
double

- Packet Error Rate

PHY_StopListeningToChannel

void PHY_StopListeningToChannel (Node* node, int phyIndex, int channelIndex) Parameters:

node

- Node that is being - interface number - channel index

phyIndex

channelIndex

Returns:
void

- None

PHY_CanListenToChannel

BOOL PHY_CanListenToChannel (Node* node, int phyIndex, int channelIndex) Parameters:

Check if it can listen to the channel

node

- Node that is being - interface number - channel index

phyIndex

channelIndex

phyNum

Returns:
BOOL

- None

PHY_MediumIsIdleInDirection

BOOL PHY_MediumIsIdleInDirection (Node* node, int phyNum, double azimuth)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Parameters: Check if the medium is idle if sensed directionally

node

- Node that is being - interface number - azimuth (in degrees)

phyNum

azimuth

Returns:
BOOL

- None

PHY_SetSensingDirection

void PHY_SetSensingDirection (Node* node, int phyNum, double azimuth) Parameters:

Set the sensing direction

node

- Node that is being - interface number - azimuth (in degrees)

phyNum

azimuth

Returns:
void

- None

PHY_StartTransmittingSignalDirectionally

void PHY_StartTransmittingSignalDirectionally (Node* node, int phyNum, Message* msg, BOOL useMacLayerSpecifiedDelay, clocktype delayUntilAirborne, double directionAzimuth) Parameters:

Start transmitting a signal directionally

node

- Node that is - interface number

phyNum msg

- signal to transmit - use delay specified by MAC

useMacLayerSpecifiedDelay delayUntilAirborne directionAzimuth

- delay until airborne

- azimuth to transmit the signal

Returns:
void

- None

PHY_LockAntennaDirection

void PHY_LockAntennaDirection (Node* node, int phyNum) Parameters:

Lock the direction of antenna

Returns:
void

- None

PHY_PropagationRange

double PHY_PropagationRange (Node* txnode, Node* node, int txInterfaceIndex, int interfaceIndex, int channnelIndex, BOOL printAll) Parameters:

Calculates an estimated radio range for the PHY. Supports only TWO-RAY and FREESPACE.

txnode

- the Tx node of interest

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

node

- the Rx node of interest - the interface for the TX node

txInterfaceIndex interfaceIndex channnelIndex printAll

- the interface for the Rx node

- the index of the channel

- if TRUE, prints the range for all data

Returns:
double

- the range in meters

ENERGY_Init

void ENERGY_Init (Node* node, const int phyIndex, NodeInput* nodeInput) Parameters:

This function declares energy model variables and initializes them. Moreover, the function read energy model specifications and configures the parameters which are configurable.

node

- the node of interest. - the PHY index. - the node input.

phyIndex

nodeInput

Returns:
void

- None

ENERGY_PrintStats

void ENERGY_PrintStats (Node* node, const int phyIndex) Parameters:

To print the statistic of Energy Model.

node

- the node of interest. - the PHY index.

phyIndex

Returns:
void

- None

Phy_ReportStatusToEnergyModel

void Phy_ReportStatusToEnergyModel (Node* node, const int phyIndex, PhyStatusType prevStatus, PhyStatusType newStatus) Parameters:

node

- the node of interest. - the PHY index. - the the previous status.

phyIndex

prevStatus newStatus

- the the new status.

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

Generic_UpdateCurrentLoad

void Generic_UpdateCurrentLoad (Node* node, const int phyIndex) Parameters:

To update the current load of generic energy model.

node

- the node of interest. - the PHY index.

phyIndex

Returns:
void

- None

PHY_GetSteeringAngle

void PHY_GetSteeringAngle (Node* node, int phyIndex) Parameters:

Gets the current steering angle for a directional antenna from PHY models that support this.

node

- node being used - physical to be initialized

phyIndex

Returns:
void

- None

PHY_CheckPacketPhyDrop

void PHY_CheckPacketPhyDrop (PartitionData* partition, PropChannel* propChannel, int numNodes, int channelIndex, Message* msg) Parameters:

This function is for Stats DB. It is to check whether need to record a drop event.

partition

- partition where receiver is located - channel information

propChannel numNodes

- Number of nodes in the partition - Index of the propagation channel

channelIndex msg

- Message under propagation

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PHYSICAL LAYER

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PHYSICAL LAYER.html[5/24/2011 12:38:50 PM]

PROPAGATION

EXata 2.2 API Specification

PROPAGATION
This file describes data structures and functions used by propagation models. Constant / Data Structure Summary Type
CONSTANT

Name
BOLTZMANN_CONSTANT

Boltzmann constant
CONSTANT NEGATIVE_PATHLOSS_dB

Path loss in dB (used as an invalid value)

CONSTANT SPEED_OF_LIGHT

Defines the value of speed of light

CONSTANT PROP_DEFAULT_PROPAGATION_LIMIT_dBm

Default value for propagation limit.

CONSTANT PROP_DEFAULT_SHADOWING_MEAN_dB

Default mean value for shadowing in dB

CONSTANT MAX_NUM_ELEVATION_SAMPLES

Maximum number of sample would be taken.

ENUMERATION PathlossModel

Different type of path loss.

ENUMERATION ShadowingModel

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Different type of shadowing used.

ENUMERATION FadingModel

Different type of fading used.

ENUMERATION propagationEnvironment

Different type of propagation environment.

ENUMERATION LoSIndicator

Indicated if the path is Line of sight OR non-Line of sight

ENUMERATION SuburbanTerrainType

Terrain types for Suburban-foliage model

ENUMERATION IndoorLinkType

Link types for Indoor model

ENUMERATION LinkType

Link types for model

STRUCT PropPathProfile

Structure that keeps track of all propertice of a path.

STRUCT PropChannel

structure of a channel.
STRUCT PropProfile

Main structure of propagation profile

STRUCT PropData

Main structure of propagation data.

STRUCT PropTxInfo

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

This structure is used for fields related to channel layer information that need to be sent with a message.
STRUCT PropRxInfo

This structure is used for fields related to channel layer information that need to be received with a message.

Function / Macro Summary Return Type

MACRO

Summary
PROP_NumberChannels(node)

Get the number of channel.

MACRO PROP_ChannelWavelength(node, channelIndex)

Get wavelength of channel having index channelIndex

void PROP_GlobalInit(PartitionData* partitionData, NodeInput* nodeInput)

Initialization function for propagation This function is called from each partition, not from each node
void PROP_PartitionlInit(PartitionData* partitionData, NodeInput* nodeInput)

Initialize some partition specific data structures. This function is called from each partition, not from each node This function is only called for non-MPI
void PROP_Init(Node* node, int channelIndex, NodeInput* nodeInput)

Initialization function for propagation functions. This function is called from each node.
void PROP_ProcessEvent(Node* node, Message* msg)

To receive message.
void PROP_Finalize(Node* node)

To collect various result.

double PROP_PathlossFreeSpace(double distance, double wavelength)

Calculates pathloss using free space model.

double PROP_PathlossTwoRay(double distance, double wavelength, float txAntennaHeight, float rxAntennaHeight)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

To calculate path loss of a channel.

double PROP_PathlossOpar(double distance, double OverlappingDistance, double frequency, ObstructionType obstructiontype)

Calculates extra path attenuation using opar model.

void PROP_CalculatePathloss(Node* node, NodeId txNodeId, NodeId rxNodeId, int channelIndex, double wavelength, float txAntennaHeight, float rxAntennaHeight, PropPathProfile* pathProfile, bool forBinning)

To calculate path loss of a channel.

void PROP_CalculateFading(PropTxInfo* propTxInfo, Node* node2, int channelIndex, clocktype currentTime, float* fading_dB, double* channelReal, double* channelImag)

To calculate fading between two node.

BOOL PROP_CalculateRxPowerAndPropagationDelay(Message* msg, int channelIndex, PropChannel* propChannel, PropTxInfo* propTxInfo, Node* txNode, Node* rxNode, PropPathProfile* pathProfile)

This function will be called by QualNet wireless propagation code to calculate rxPower and prop delay for a specific signal from a specific tx node to a specific rx node.
BOOL PROP_CalculateRxPowerAndPropagationDelay(Message* msg, int channelIndex, PropChannel* propChannel, PropTxInfo* propTxInfo, Node* txNode, Node* rxNode, PropPathProfile* pathProfile)

This function will be called by QualNet wireless propagation code to calculate rxPower and prop delay for a specific signal from a specific tx node to a specific rx node.
void PROP_MotionObtainfadingStretchingFactor(PropTxInfo* propTxInfo, Node* receiver, int channelIndex)

Get a stretching factor for fast moving objects.

void PROP_UpdatePathProfiles(Node* node)

UpdatePathProfiles
void PROP_ReleaseSignal(Node* node, Message* msg, int phyIndex, int channelIndex, float txPower_dBm, clocktype duration, clocktype delayUntilAirborne)

Release (transmit) the signal

void PROP_SubscribeChannel(Node* node, int phyIndex, int channelIndex)

Start subscribing (listening to) a channel

void PROP_UnsubscribeChannel(Node* node, int phyIndex, int channelIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Stop subscription of (listening to) a channel

void PROP_UnreferenceSignal(Node* node, Message* msg)

Unreference a signal (internal use)

void PROP_CalculateInterNodePathLossOnChannel(Node* node, int channelIndex, int* numNodesOnChannel, NodeAddress* nodeIdList, float** pathloss_dB, float** distance)

Calculate inter-node pathloss, distance values between all the nodes on a given channel
clocktype PROP_CalculatePropagationDelay(double distance, double propSpeed, PartitionData* partitionData, int channelIndex, int coordinateSystemType, Coordinates* fromPosition, Coordinates* toPosition)

Calculate the wireless propagation delay for the given distance and propagation speed.
void PROP_Reset(Node* node, int phyIndex, char* newChannelListenable)

Reset previous channel remove/add node to propChannel for signal delivery, in propagation_private.
void PROP_AddNodeToList(Node* node, int channelIndex)

add node to propChannel nodeList need to make sure that node is not already exists in list before adding.
void PROP_RemoveNodeFromList(Node* node, int channelIndex)

remove node from propChannel nodeList need to make sure that all the interface from that node is not listing on that channel before removing.
double PROP_GetChannelFrequency(Node* node, int channelIndex)

Get channel frequency from profile for PropChannel.

void PROP_SetChannelFrequency(Node* node, int channelIndex, double channelFrequency)

Set channel frequency from profile for PropChannel.

double PROP_GetChannelWavelength(Node* node, int channelIndex)

Get channel wavelength from profile for PropChannel.

void PROP_SetChannelWavelength(Node* node, int channelIndex, double channelWavelength)

Set channel wavelength from profile for PropChannel.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

double

PROP_GetChannelDopplerFrequency(Node* node, int channelIndex)

Get channel doppler freq from profile for PropChannel.

void PROP_SetChannelDopplerFrequency(Node* node, int channelIndex, double channelDopplerFrequency)

Set channel doppler freq from profile for PropChannel.

Constant / Data Structure Detail

Constant

BOLTZMANN_CONSTANT 1.379e-23

Enumeration

Different type of path loss. ShadowingModel

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Structure

Main structure of propagation data. PropTxInfo

Structure

This structure is used for fields related to channel layer information that need to be sent with a message. PropRxInfo

This structure is used for fields related to channel layer information that need to be received with a message.

Function / Macro Detail Function / Macro PROP_NumberChannels(node) Format Get the number of channel.

PROP_ChannelWavelength(node, channelIndex)

Get wavelength of channel having index channelIndex

PROP_GlobalInit

void PROP_GlobalInit (PartitionData* partitionData, NodeInput* nodeInput) Parameters:

Initialization function for propagation This function is called from each partition, not from each node

partitionData nodeInput

- structure shared among nodes

- structure containing contents of input file

Returns:
void

- None

PROP_PartitionlInit

void PROP_PartitionlInit (PartitionData* partitionData, NodeInput* nodeInput) Parameters:

Initialize some partition specific data structures. This function is called from each partition, not from each node This function is only called for non-MPI

partitionData nodeInput

- structure shared among nodes

- structure containing contents of input file

Returns:
void

- None

PROP_Init

void PROP_Init (Node* node, int channelIndex, NodeInput* nodeInput) Parameters:

Initialization function for propagation functions.

node

- node being initialized.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

This function is called from each node.

channelIndex nodeInput

- channel being initialized.

- structure containing contents of input file

Returns:
void

- None

PROP_ProcessEvent

void PROP_ProcessEvent (Node* node, Message* msg) Parameters:

To receive message.

node msg

- Node that is

- message received by the layer

Returns:
void

- None

PROP_Finalize

void PROP_Finalize (Node* node) Parameters:

To collect various result.

node

- node for which results are to be collected

Returns:
void

- None

PROP_PathlossFreeSpace

double PROP_PathlossFreeSpace (double distance, double wavelength) Parameters:

Calculates pathloss using free space model.

distance

- distance (meters) between two nodes - wavelength used for propagation.

wavelength

Returns:
double

- pathloss in db

PROP_PathlossTwoRay

double PROP_PathlossTwoRay (double distance, double wavelength, float txAntennaHeight, float rxAntennaHeight) Parameters:

To calculate path loss of a channel.

distance

- distance (meters) between two nodes - wavelength used for propagation. - tranmitting antenna hight. - receiving antenna hight.

wavelength

txAntennaHeight rxAntennaHeight

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Returns:
double

- pathloss in db

PROP_PathlossOpar

double PROP_PathlossOpar (double distance, double OverlappingDistance, double frequency, ObstructionType obstructiontype) Parameters:

Calculates extra path attenuation using opar model.

distance

- distance (meters) between two nodes - overlapping distance

OverlappingDistance frequency

- frequency used for propagation. - obstruction type

obstructiontype

Returns:
double

- extra path attenuation in db

PROP_CalculatePathloss

void PROP_CalculatePathloss (Node* node, NodeId txNodeId, NodeId rxNodeId, int channelIndex, double wavelength, float txAntennaHeight, float rxAntennaHeight, PropPathProfile* pathProfile, bool forBinning) Parameters:

To calculate path loss of a channel.

node

- Node that is - including for debugging - including for debugging - channel number.

txNodeId rxNodeId

channelIndex wavelength

- wavelength used for propagation. - tranmitting antenna hight. - receiving antenna hight.

txAntennaHeight rxAntennaHeight pathProfile forBinning

- characteristics of path.

- disables some features to support

Returns:
void

- None

PROP_CalculateFading

void PROP_CalculateFading (PropTxInfo* propTxInfo, Node* node2, int channelIndex, clocktype currentTime, float* fading_dB, double* channelReal, double* channelImag) Parameters:

To calculate fading between two node.

propTxInfo

- Information about the transmitter

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

node2

- receiver - channel number

channelIndex currentTime fading_dB

- current simulation time

- calculated fading store here. - for cooperative comm - for cooperative comm

channelReal channelImag

Returns:
void

- None

PROP_CalculateRxPowerAndPropagationDelay

BOOL PROP_CalculateRxPowerAndPropagationDelay (Message* msg, int channelIndex, PropChannel* propChannel, PropTxInfo* propTxInfo, Node* txNode, Node* rxNode, PropPathProfile* pathProfile) Parameters:

This function will be called by QualNet wireless propagation code to calculate rxPower and prop delay for a specific signal from a specific tx node to a specific rx node.

msg

- Signal to be propagated - Channel that the signal is propagated

channelIndex propChannel propTxInfo txNode rxNode

- Info of the propagation channel

- Transmission parameers of the tx node

- Point to the Tx node - Point to the Rx node - For returning results

pathProfile

Returns:
BOOL

- If FALSE, indicate the two nodes cannot comm TRUE means two nodes can communicate

PROP_CalculateRxPowerAndPropagationDelay

BOOL PROP_CalculateRxPowerAndPropagationDelay (Message* msg, int channelIndex, PropChannel* propChannel, PropTxInfo* propTxInfo, Node* txNode, Node* rxNode, PropPathProfile* pathProfile) Parameters:

This function will be called by QualNet wireless propagation code to calculate rxPower and prop delay for a specific signal from a specific tx node to a specific rx node.

msg

- Signal to be propagated - Channel that the signal is propagated

channelIndex propChannel propTxInfo txNode rxNode

- Info of the propagation channel

- Transmission parameers of the tx node

- Point to the Tx node - Point to the Rx node

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

pathProfile

- For returning results

Returns:
BOOL

- If FALSE, indicate the two nodes cannot comm TRUE means two nodes can communicate

PROP_MotionObtainfadingStretchingFactor

void PROP_MotionObtainfadingStretchingFactor (PropTxInfo* propTxInfo, Node* receiver, int channelIndex) Parameters:

Get a stretching factor for fast moving objects.

propTxInfo receiver

- Transmitter information

- Receiver node. - channel number

channelIndex

Returns:
void

- None

PROP_UpdatePathProfiles

void PROP_UpdatePathProfiles (Node* node) Parameters:

UpdatePathProfiles

node

- Node that is

Returns:
void

- None

PROP_ReleaseSignal

void PROP_ReleaseSignal (Node* node, Message* msg, int phyIndex, int channelIndex, float txPower_dBm, clocktype duration, clocktype delayUntilAirborne) Parameters:

Release (transmit) the signal

node msg

- Node that is

- Signal to be transmitted - PHY data index - chanel index

phyIndex

channelIndex txPower_dBm duration

- transmitting power

- transmission duration - delay until airborne

delayUntilAirborne

Returns:
void

- None

PROP_SubscribeChannel

void PROP_SubscribeChannel (Node* node, int phyIndex, int channelIndex)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Parameters: Start subscribing (listening to) a channel

node

- Node that is - interface index - chanel index

phyIndex

channelIndex

Returns:
void

- None

PROP_UnsubscribeChannel

void PROP_UnsubscribeChannel (Node* node, int phyIndex, int channelIndex) Parameters:

Stop subscription of (listening to) a channel

node

- Node that is - interface index - chanel index

phyIndex

channelIndex

Returns:
void

- None

PROP_UnreferenceSignal

void PROP_UnreferenceSignal (Node* node, Message* msg) Parameters:

Unreference a signal (internal use)

node msg

- Node that is

- Signal to be unreferenced

Returns:
void

- None

PROP_CalculateInterNodePathLossOnChannel

void PROP_CalculateInterNodePathLossOnChannel (Node* node, int channelIndex, int* numNodesOnChannel, NodeAddress* nodeIdList, float** pathloss_dB, float** distance) Parameters:

Calculate inter-node pathloss, distance values between all the nodes on a given channel

node

- any valid node - selected channel instance - number of nodes using this channel

channelIndex

numNodesOnChannel nodeIdList

- list of (numNodesOnChannel) nodeIds - 2D pathloss array for nodes in

pathloss_dB distance

- 2D array of inter-node distances

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Returns:
void

- None

PROP_CalculatePropagationDelay

clocktype PROP_CalculatePropagationDelay (double distance, double propSpeed, PartitionData* partitionData, int channelIndex, int coordinateSystemType, Coordinates* fromPosition, Coordinates* toPosition) Parameters:

Calculate the wireless propagation delay for the given distance and propagation speed.

distance

- Propagation distance - Propagation speed - Partition data

propSpeed

partitionData channelIndex

- Channel index or -1 for p2p - Coordinate system type

coordinateSystemType fromPosition toPosition

- Source position

- Destination position

Returns:
clocktype

- Calculated propagation delay COMMENTS :: + partitionData can be used to get the simulation time or terrain data + channelIndex indicates the channel for scenarios with multiple channels Wireless p2p link or microwave links don't use propagation channels. -1 will be passed in which indicate p2p/microwave links. + fromPosition and toPosition are not used right now. They can be used to calculate location specific delay.

PROP_Reset

void PROP_Reset (Node* node, int phyIndex, char* newChannelListenable) Parameters:

Reset previous channel remove/add node to propChannel for signal delivery, in propagation_private.

node

- Node that is being instantiated in - interface index - new channel

phyIndex

newChannelListenable

Returns:
void

- None

PROP_AddNodeToList

void PROP_AddNodeToList (Node* node, int channelIndex) Parameters:

add node to propChannel nodeList need to make sure that node is not already exists in list before adding.

node

- the node - channel index

channelIndex

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

Returns:
void

- None

PROP_GetChannelWavelength

double PROP_GetChannelWavelength (Node* node, int channelIndex) Parameters:

Get channel wavelength from profile for PropChannel.

node

- the node - channel index

channelIndex

Returns:
double

- channel wavelength

PROP_SetChannelWavelength

void PROP_SetChannelWavelength (Node* node, int channelIndex, double channelWavelength) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

PROPAGATION

Set channel wavelength from profile for PropChannel.

node

- the node - channel index - new channel wavelength

channelIndex

channelWavelength

Returns:
void

- None

PROP_GetChannelDopplerFrequency

double PROP_GetChannelDopplerFrequency (Node* node, int channelIndex) Parameters:

Get channel doppler freq from profile for PropChannel.

node

- the node - channel index

channelIndex

Returns:
double

- channel doppler freq

PROP_SetChannelDopplerFrequency

void PROP_SetChannelDopplerFrequency (Node* node, int channelIndex, double channelDopplerFrequency) Parameters:

Set channel doppler freq from profile for PropChannel.

node

- the node - channel index - new channel doppler freq

channelIndex

channelDopplerFrequency

Returns:
void

- None

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/PROPAGATION.html[5/24/2011 12:39:02 PM]

QUEUES

EXata 2.2 API Specification

QUEUES
This file describes the member functions of the queue base class. Constant / Data Structure Summary Type
CONSTANT

Name
DEQUEUE_NEXT_PACKET

Denotes position of packet in the queue for dequeue operation

CONSTANT ALL_PRIORITIES

This macro is used to specify that queue and scheduler operations not consider priority value of queue or packet
CONSTANT QOS_DEFAULT_INTERFACE_OBSERVATION_INTERVAL

This macro is used to specify the interface observation interval for Qos Routing. Ref.(Qospf.h see QOSPF_DEFAULT_INTERFACE_OBSERVATION_INTERVAL)
CONSTANT STATISTICS_RESOLUTION

This macro is used to support overflow issue to account for long delay network such as in space applications, or simply very very long simulations, divide delays by STATISTICS_RESOLUTION during runtime, and multiply by STATISTICS_RESOLUTION at the end of the simulation when IO_PrintStat'ing
CONSTANT DEFAULT_QUEUE_DELAY_WEIGHT_FACTOR

This macro is used to define the weight to assign to the most recent delay in calculating an exponential moving average. The value is fairly large because the queue delay is used for QoS routing decisions.
CONSTANT PACKET_ARRAY_INFO_FIELD_SIZE

The Queue structure will store a field of data in addition to the Message itself, with a maximum size of this value
ENUMERATION QueueBehavior

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

This enumeration is used by both queues and schedulers to determine the queue behavior.
ENUMERATION QueueOperation

This enumeration is used by both queues and schedulers to determine the operation of the retrieve functions.
STRUCT PacketArrayEntry

This structure represents an entry in the array of stored messages. The infoField (perhaps this should be renamed to prevent confusion) will store a queue algorithm dependent amount of data about each Message, as well as the simulation time that Message was inserted.
STRUCT QueueAgeInfo

This structure contains information for each packet inserted into the queue to uniquely identify it so that it can be removed from the queue due to age.

Function / Macro Summary Return Type

void

Summary
Queue(Message* msg, const void* infoField, BOOL* QueueIsFull, const clocktype currentTime, const double serviceTag)

This function prototype determines the arguments that need to be passed to a queue data structure in order to insert a message into it. The infoField parameter has a specified size infoFieldSize, which is set at Initialization, and points to the structure that should be stored along with the Message.
BOOL Queue(Message** msg, const int index, const QueueOperation operation, const clocktype currentTime, double* serviceTag)

This function prototype determines the arguments that need to be passed to a queue data structure in order to dequeue, peek at, or drop a message in its array of stored messages. It now includes the "DropFunction" functionality as well.
BOOL Queue()

This function prototype returns a Boolean value of true if the array of stored messages is empty, false otherwise.
int Queue()

This function prototype returns the number of bytes stored in the array.
int Queue()

This function prototype returns free space in number of bytes in the queue.
int Queue()
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

This function prototype returns the number of Messages stored in the packetArray.
int Queue()

This function prototype returns the size of the Queue

void Queue(double serviceTag)

Set the service tag of the queue

int Queue(Queue* oldQueue)

This function is proposed to replicate the state of the queue, as if it had been the operative queue all along. If there are packets in the existing queue, they are transferred one-by-one into the new queue. This can result in additional drops of packets that had previously been stored. This function returns the number of additional drops.
void Queue(BOOL suspend)

This function is proposed to identify and tag misbehaved queue at the interface, so that they can be punished.
void Queue(int* qDelayVal, int* totalTransmissionVal, const clocktype currentTime, BOOL isResetTotalTransmissionVal)

This function is proposed for qos information update for Qos Routings like Qospf.
int Queue()

This function prototype returns the number of bytes dequeued, not dropped, during a given period. This period starts at the beginning of the simulation, and restarts whenever the Queue resetPeriod function is called.
clocktype Queue()

This function prototype returns the queue utilization, or the amount of time that the queue is nonempty, during a given period. This period starts at the beginning of the simulation, and restarts whenever the queue resetPeriod function is called.
clocktype Queue()

This function prototype returns the average time a packet spends in the queue, during a given period. This period starts at the beginning of the simulation, and restarts whenever the QueueResetPeriodFunctionType function is called.
void Queue(clocktype currentTime)

This function prototype resets the current period statistics variables, and sets the currentPeriodStartTime to the currentTime.
clocktype Queue()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

This function prototype returns the currentPeriodStartTime.

void Queue(Node* node, const char* layer, const int interfaceIndex, const int instanceId, const char* invokingProtocol, const char* splStatStr)

This function prototype outputs the final statistics for this queue. The layer, protocol, interfaceAddress, and instanceId parameters are given to IO_PrintStat with each of the queue's statistics.
void Queue(Node* node, const char queueTypeString[], const int queueSize, const int interfaceIndex, const int queueNumber, const int infoFieldSize, const BOOL enableQueueStat, const BOOL showQueueInGui, const clocktype currentTime, const void* configInfo)

This function runs queue initialization routine. Any algorithm specific configurable parameters will be kept in a structure and after feeding that structure the structure pointer will be sent to this function via that void pointer configInfo. Some parameters includes default values, to prevent breaking existing models. [Uses: vide Pseudo code]

Constant / Data Structure Detail

Constant

DEQUEUE_NEXT_PACKET 0

Constant

Denotes position of packet in the queue for dequeue operation ALL_PRIORITIES -1

Constant

This macro is used to specify that queue and scheduler operations not consider priority value of queue or packet QOS_DEFAULT_INTERFACE_OBSERVATION_INTERVAL 2 * SECOND

Constant

This macro is used to specify the interface observation interval for Qos Routing. Ref.(Qospf.h see QOSPF_DEFAULT_INTERFACE_OBSERVATION_INTERVAL) STATISTICS_RESOLUTION 1 * MICRO_SECOND

Constant

This macro is used to define the weight to assign to the most recent delay in calculating an exponential moving average. The value is
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

Constant

fairly large because the queue delay is used for QoS routing decisions. PACKET_ARRAY_INFO_FIELD_SIZE 32

Enumeration

The Queue structure will store a field of data in addition to the Message itself, with a maximum size of this value QueueBehavior

Enumeration

This enumeration is used by both queues and schedulers to determine the queue behavior. QueueOperation

Structure

This enumeration is used by both queues and schedulers to determine the operation of the retrieve functions. PacketArrayEntry

Structure

This structure contains information for each packet inserted into the queue to uniquely identify it so that it can be removed from the queue due to age.

Function / Macro Detail Function / Macro Queue Format void Queue (Message* msg, const void* infoField, BOOL* QueueIsFull, const clocktype currentTime, const double serviceTag) Parameters: This function prototype determines the arguments that need to be passed to a queue data structure in order to insert a message into it. The infoField parameter has a specified size infoFieldSize, which is set at Initialization, and points to the structure that should be stored along with the Message.
msg

- Pointer to Message structure - The infoField parameter - returns Queue occupancy status - Current Simulation time

infoField

QueueIsFull currentTime serviceTag

- ServiceTag

Returns:
void

- Null

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

Queue

BOOL Queue (Message** msg, const int index, const QueueOperation operation, const clocktype currentTime, double* serviceTag) Parameters:

msg

- The retrieved msg - The position of the packet in the queue - The retrieval mode - Current Simulation time

index

operation

currentTime serviceTag

- ServiceTag = NULL

Returns:
BOOL

- TRUE or FALSE

Queue

BOOL Queue () Parameters:

This function prototype returns a Boolean value of true if the array of stored messages is empty, false otherwise. Queue

Returns:
BOOL

- TRUE or FALSE

int Queue () Parameters:

This function prototype returns the number of bytes stored in the array. Queue

Returns:
int

- Integer

Returns:
int

- Integer

void Queue (double serviceTag) Parameters:

Set the service tag of the queue

serviceTag

- the value of the service tag

Returns:
void

- NULL

Queue

int Queue (Queue* oldQueue) Parameters:

oldQueue

- Old queue pointer

Returns:
int

- Old packetArray

void Queue (BOOL suspend) Parameters:

This function is proposed to identify and tag misbehaved queue at the interface, so that they can be punished.

suspend

- The queue status

Returns:
void

- Null

Queue

void Queue (int* qDelayVal, int* totalTransmissionVal, const clocktype currentTime, BOOL isResetTotalTransmissionVal) Parameters:

This function is proposed for qos information update for Qos Routings like Qospf.

qDelayVal

- Returning qDelay value - Returning totalTransmission value

totalTransmissionVal currentTime

- Current simulation time - Default false

isResetTotalTransmissionVal

Returns:
void

- Null

Queue

int Queue ()

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

Parameters: This function prototype returns the number of bytes dequeued, not dropped, during a given period. This period starts at the beginning of the simulation, and restarts whenever the Queue resetPeriod function is called. Queue Returns:
int

- Integer

clocktype Queue () Parameters:

Returns:
clocktype

- Utilize Time.

clocktype Queue () Parameters:

Returns:
clocktype

- Queue Delays.

void Queue (clocktype currentTime) Parameters:

This function prototype resets the current period statistics variables, and sets the currentPeriodStartTime to the currentTime.

currentTime

- Current simulation time.

Returns:
void

- Null

Queue

clocktype Queue () Parameters:

This function prototype returns the currentPeriodStartTime. Queue

Returns:
clocktype

- Current period start time.

void Queue (Node* node, const char* layer, const int interfaceIndex, const int instanceId, const char* invokingProtocol, const char* splStatStr) Parameters:

This function prototype outputs the final statistics for this queue. The layer, protocol, interfaceAddress, and instanceId parameters

node

- Pointer to Node structure

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

are given to IO_PrintStat with each of the queue's statistics.

layer

- The layer string - The interface index

interfaceIndex instanceId

- Instance Ids - The protocol string

invokingProtocol splStatStr

- Special string for stat print

Returns:
void

- Null

Queue

void Queue (Node* node, const char queueTypeString[], const int queueSize, const int interfaceIndex, const int queueNumber, const int infoFieldSize, const BOOL enableQueueStat, const BOOL showQueueInGui, const clocktype currentTime, const void* configInfo) Parameters:
node

- Node pointer - Queue type string

queueTypeString[] queueSize

- Queue size in bytes - used to set random seed

interfaceIndex queueNumber

- used to set random seed - Default infoFieldSize = 0 - Default enableQueueStat = false

infoFieldSize

enableQueueStat showQueueInGui currentTime configInfo

- If want to show this Queue in GUI

- Current simulation time

- pointer to a structure that contains

Returns:
void

- Null

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

QUEUES

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/QUEUES.html[5/24/2011 12:39:19 PM]

RANDOM NUMBERS

EXata 2.2 API Specification

RANDOM NUMBERS
This file describes functions to generate pseudo-random number streams. Constant / Data Structure Summary Type
ENUMERATION

Name
RandomDistributionType

Random function types

ENUMERATION RandomDataType

Used for parsing input strings.

STRUCT ValueProbabilityPair

Stores one data point in a user defined distribution.

STRUCT ArbitraryDistribution

Stores a user defined distribution.

Function / Macro Summary Return Type

void

Summary
RANDOM_SetSeed(RandomSeed seed, UInt32 globalSeed, UInt32 nodeId, UInt32 protocolId, UInt32 instanceId)

Chooses from a set of pre-defined independent random seeds. The parameter names here are recommend invariants for use in selecting seeds, but other values could be used instead.
double RANDOM_erand(RandomSeed seed)

Returns a uniform distribution in [0.0 .. 1.0]

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

Int32

RANDOM_jrand(RandomSeed seed)

Returns an integer uniformly distributed between -2^31 and 2^31.

Int32 RANDOM_nrand(RandomSeed seed)

Returns an integer uniformly distributed between 0 and 2^31.

void RANDOM_LoadUserDistributions(NodeInput* nodeInput)

Loads all user defined distributions.

void RandomDistribution.init()

Initializes the random distribution

void RandomDistribution.setDistributionUniform(T min, T max)

Sets the distribution to uniform. With this function, even integer types return values between [min, max), meaning to get a boolean distribution, use 0, 2.
void RandomDistribution.setDistributionUniformInteger(T min, T max)

This one gives [min, max] for integers.

void RandomDistribution.setDistributionExponential(T mean)

Sets the distribution to exponential with the given mean.

void RandomDistribution.setDistributionGaussian(T sigma)

Sets the distribution to Gaussian with the given sigma

void RandomDistribution.setDistributionGaussianInt(T sigma)

Sets the distribution to Gaussian with the given sigma

void RandomDistribution.setDistributionPareto(T val1, T val2, double alpha)

Sets the distribution to the truncated Pareto distribution

void RandomDistribution.setDistributionPareto4(T val1, T val2, T val3, double alpha)

Sets the distribution to the truncated Pareto distribution

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

void

RandomDistribution.setDistributionGeneralPareto(T val1, T val2, double alpha)

Sets the distribution to general Pareto distribution

void RandomDistribution.setDistributionParetoUntruncated(double alpha)

Sets the distribution to the truncated Pareto distribution

void RandomDistribution.setDistributionDeterministic(T val)

The distribution will always return val.

void RandomDistribution.setDistributionNull()

The distribution will return 0. This is used for initialization.

int RandomDistribution.setDistribution(char* inputString, char* printStr, RandomDataType dataType)

Sets the distribution by parsing string input.

T RandomDistribution.getRandomNumber(RandomSeed seed, Node* node)

These two functions return the next random number from the defined distribution.
void RandomDistribution.setSeed(UInt32 globalSeed, UInt32 nodeId, UInt32 protocolId, UInt32 instanceId)

Calls RANDOM_SetSeed on the member seed.

void RandomDistribution.setSeed(RandomSeed seed)

Copies the parameter seed into the member seed.

Constant / Data Structure Detail

Enumeration

RandomDistributionType

Enumeration

Random function types RandomDataType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

Structure

Used for parsing input strings. ValueProbabilityPair

Structure

Stores one data point in a user defined distribution. ArbitraryDistribution

Stores a user defined distribution.

Function / Macro Detail Function / Macro RANDOM_SetSeed Format void RANDOM_SetSeed (RandomSeed seed, UInt32 globalSeed, UInt32 nodeId, UInt32 protocolId, UInt32 instanceId) Parameters: Chooses from a set of pre-defined independent random seeds. The parameter names here are recommend invariants for use in selecting seeds, but other values could be used instead.
seed

- the seed to be set. - the scenario's global seed, i.e. SEED in the

globalSeed nodeId

- the node's ID - the protocol number, as defined in the layer - the instance of this protocol, often the

protocolId instanceId

Returns:
void

- None

RANDOM_erand

double RANDOM_erand (RandomSeed seed) Parameters:

Returns a uniform distribution in [0.0 .. 1.0]

seed

- the seed for this random stream.

Returns:
double

- a random number

RANDOM_jrand

Int32 RANDOM_jrand (RandomSeed seed) Parameters:

Returns an integer uniformly distributed between -2^31 and 2^31.

seed

- the seed for this random stream.

Returns:
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

Int32

- a random number

RANDOM_nrand

Int32 RANDOM_nrand (RandomSeed seed) Parameters:

Returns an integer uniformly distributed between 0 and 2^31.

seed

- the seed for this random stream.

Returns:
Int32

- a random number

RANDOM_LoadUserDistributions

void RANDOM_LoadUserDistributions (NodeInput* nodeInput) Parameters:

Loads all user defined distributions.

nodeInput

- the .config file

Returns:
void

- None

RandomDistribution.init

void RandomDistribution.init () Parameters:

Initializes the random distribution

Returns:
void

- None

RandomDistribution.setDistributionUniform

void RandomDistribution.setDistributionUniform (T min, T max) Parameters:

Sets the distribution to uniform. With this function, even integer types return values between [min, max), meaning to get a boolean distribution, use 0, 2.

min max

- the low end of the range - the high end of the range

Returns:
void

- None

RandomDistribution.setDistributionUniformInteger

void RandomDistribution.setDistributionUniformInteger (T min, T max) Parameters:

This one gives [min, max] for integers.

min max

- the low end of the range - the high end of the range

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

RandomDistribution.setDistributionExponential

void RandomDistribution.setDistributionExponential (T mean) Parameters:

Sets the distribution to exponential with the given mean.

mean

- the mean value of the distribution

Returns:
void

- None

RandomDistribution.setDistributionGaussian

void RandomDistribution.setDistributionGaussian (T sigma) Parameters:

Sets the distribution to Gaussian with the given sigma

sigma

- the sigma value

Returns:
void

- None

RandomDistribution.setDistributionGaussianInt

void RandomDistribution.setDistributionGaussianInt (T sigma) Parameters:

Sets the distribution to Gaussian with the given sigma

sigma

- the sigma value

Returns:
void

- None

RandomDistribution.setDistributionPareto

void RandomDistribution.setDistributionPareto (T val1, T val2, double alpha) Parameters:

Sets the distribution to the truncated Pareto distribution

val1 val2

- the low end of the range - the high end of the range - the alpha value

alpha

Returns:
void

- None

RandomDistribution.setDistributionPareto4

void RandomDistribution.setDistributionPareto4 (T val1, T val2, T val3, double alpha) Parameters:

Sets the distribution to the truncated Pareto distribution

val1 val2 val3

- the minimum value of Pareto distribution - the low end of the range - the high end of the range - the alpha value

alpha

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

Returns:
void

- None

RandomDistribution.setDistributionGeneralPareto

void RandomDistribution.setDistributionGeneralPareto (T val1, T val2, double alpha) Parameters:

Sets the distribution to general Pareto distribution

val1 val2

Returns:
void

- None

int RandomDistribution.setDistribution (char* inputString, char* printStr, RandomDataType dataType) Parameters:

Sets the distribution by parsing string input.

inputString printStr

- the input string, typically from a line

- usually the name of the calling

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

dataType

- the data type of the template class is

Returns:
int

- returns the number of tokens read from the input string

RandomDistribution.getRandomNumber

T RandomDistribution.getRandomNumber (RandomSeed seed, Node* node) Parameters:

These two functions return the next random number from the defined distribution.

seed node

- when the seed parameter is present, it is used in - the node parameter is required to look up user

Returns:
T

- the random value

RandomDistribution.setSeed

void RandomDistribution.setSeed (UInt32 globalSeed, UInt32 nodeId, UInt32 protocolId, UInt32 instanceId) Parameters:

Calls RANDOM_SetSeed on the member seed.

globalSeed nodeId

- the scenario's global seed, i.e. SEED in the

- the node's ID - the protocol number, as defined in the layer - the instance of this protocol, often the

protocolId instanceId

Returns:
void

- None

RandomDistribution.setSeed

void RandomDistribution.setSeed (RandomSeed seed) Parameters:

Copies the parameter seed into the member seed.

seed

- an already initialized seed.

Returns:
void

- None

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

RANDOM NUMBERS

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/RANDOM NUMBERS.html[5/24/2011 12:39:43 PM]

SCHEDULERS

EXata 2.2 API Specification

SCHEDULERS
This file describes the member functions of the scheduler base class. Constant / Data Structure Summary Type
CONSTANT

Name
DEFAULT_QUEUE_COUNT

Default number of queue per interface

STRUCT QueueData

This structure contains pointers to queue structures, default function behaviors, and statistics for the scheduler

Function / Macro Summary Return Type

QueueData*

Summary
Scheduler(int priority)

Returns pointer to QueueData associated with the queue. this is a Private

int Scheduler()

Returns number of queues under this Scheduler

int Scheduler(int queueIndex)

Returns Priority for the queues under this Scheduler

BOOL Scheduler(const int priority)

Returns a Boolean value of TRUE if the array of stored messages in each queue that the scheduler controls are empty, and FALSE otherwise
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SCHEDULERS

BOOL

Scheduler(const int priority)

This function prototype returns the total number of bytes stored in the array of either a specific queue, or all queues that the scheduler controls.
int Scheduler(const int priority)

This function prototype returns the number of messages stored in the array of either a specific queue, or all queues that the scheduler controls.
void Scheduler(int queueIndex, int* qDelayVal, int* totalTransmissionVal, const clocktype currentTime, BOOL isResetTotalTransmissionVal)

This function enable Qos monitoring for all queues that the scheduler controls.
void Scheduler(int priority, int packetSize, const clocktype currentTime)

This function enable data collection for performance study of schedulers.

void Scheduler(Node* node, const char* layer, const int interfaceIndex, const int instanceId, const char* invokingProtocol, const char* splStatStr)

This function invokes queue finalization.

void SCHEDULER_Setup(Scheduler** scheduler, const char schedulerTypeString[], BOOL enableSchedulerStat, const char* graphDataStr)

This function runs the generic and then algorithm-specific scheduler initialization routine.
int GenericPacketClassifier(Scheduler* scheduler, int pktPriority)

Classify a packet for a specific queue

Constant / Data Structure Detail

Constant

DEFAULT_QUEUE_COUNT 3

Structure

Default number of queue per interface QueueData

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SCHEDULERS

This structure contains pointers to queue structures, default function behaviors, and statistics for the scheduler

Function / Macro Detail Function / Macro Scheduler Format QueueData* Scheduler (int priority) Parameters: Returns pointer to QueueData associated with the queue. this is a Private
priority

- Queue priority

Returns:
QueueData*

- Pointer of queue

Scheduler

int Scheduler () Parameters:

Returns number of queues under this Scheduler Scheduler

Returns:
int

- Number of queue.

int Scheduler (int queueIndex) Parameters:

Returns Priority for the queues under this Scheduler

queueIndex

- Queue index

Returns:
int

- Return priority of a queue

Scheduler

BOOL Scheduler (const int priority) Parameters:

Returns a Boolean value of TRUE if the array of stored messages in each queue that the scheduler controls are empty, and FALSE otherwise Scheduler

priority

- Priority of a queue

Returns:
BOOL

- TRUE or FALSE

BOOL Scheduler (const int priority) Parameters:

This function prototype returns the total number of bytes stored in the array of either a specific queue, or all queues that the scheduler controls.

priority

- Priority of a queue

Returns:
BOOL

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SCHEDULERS

- TRUE or FALSE Scheduler int Scheduler (const int priority) Parameters: This function prototype returns the number of messages stored in the array of either a specific queue, or all queues that the scheduler controls. Scheduler
priority

- Priority of a queue

Returns:
int

- Bytes in queue is used.

void Scheduler (int queueIndex, int* qDelayVal, int* totalTransmissionVal, const clocktype currentTime, BOOL isResetTotalTransmissionVal) Parameters:

This function enable Qos monitoring for all queues that the scheduler controls.

queueIndex qDelayVal

- Queue index

- Queue delay - Transmission value

totalTransmissionVal currentTime

- Current simulation time - Total Transmission is set or not

isResetTotalTransmissionVal

Returns:
void

- Null

Scheduler

void Scheduler (int priority, int packetSize, const clocktype currentTime) Parameters:

This function enable data collection for performance study of schedulers.

priority

- Priority of the queue - Size of packet - Current simulation time

packetSize

currentTime

Returns:
void

- Null

Scheduler

void Scheduler (Node* node, const char* layer, const int interfaceIndex, const int instanceId, const char* invokingProtocol, const char* splStatStr) Parameters:

This function invokes queue finalization.

node

- Pointer to Node structure - The layer string - Interface Index

layer

interfaceIndex

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SCHEDULERS

instanceId

- Instance Ids - The protocol string

invokingProtocol splStatStr

- Special string for stat print

Returns:
void

- Null

SCHEDULER_Setup

void SCHEDULER_Setup (Scheduler** scheduler, const char schedulerTypeString[], BOOL enableSchedulerStat, const char* graphDataStr) Parameters:

This function runs the generic and then algorithm-specific scheduler initialization routine.

scheduler

- Pointer of pointer to Scheduler class - Scheduler Type string

schedulerTypeString[] enableSchedulerStat graphDataStr

- Scheduler Statistics is set YES or NO

- Scheduler's graph statistics is set or not

Returns:
void

- Null

GenericPacketClassifier

int GenericPacketClassifier (Scheduler* scheduler, int pktPriority) Parameters:

Classify a packet for a specific queue

scheduler

- Pointer to a Scheduler class. - Incoming packet's priority

pktPriority

Returns:
int

- Integer.

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SCHEDULERS

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SCHEDULERS.html[5/24/2011 12:39:53 PM]

SLIDING-WINDOW

EXata 2.2 API Specification

SLIDING-WINDOW
This file describes data structures and functions to implement a sliding window. Constant / Data Structure Summary Type
STRUCT

Name
MsTmWin

sliding time window averager structure

Function / Macro Summary Return Type

void

Summary
MsTmWinInit(MsTmWin* pWin, clocktype sSize, int nSlot, double weight, clocktype theTime)

initialize time sliding window with the given parameters

void MsTmWinInit(MsTmWin* pWin, clocktype sSize, int nSlot, double weight, clocktype theTime)

resets time sliding window with the given parameters

void MsTmWinNewData(MsTmWin* pWin, double data, clocktype theTime)

updates time sliding window with the given new data

clocktype MsTmWinWinSize(MsTmWin* pWin, clocktype theTime)

returns the window size

double MsTmWinSum(MsTmWin* pWin, clocktype theTime)

computes the data sum of the window

double MsTmWinAvg(MsTmWin* pWin, clocktype theTime)
file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SLIDING-WINDOW.html[5/24/2011 12:40:08 PM]

SLIDING-WINDOW

computes the data average of the window

double MsTmWinTotalSum(MsTmWin* pWin, clocktype theTime)

computes the total data sum

double MsTmWinTotalAvg(MsTmWin* pWin, clocktype theTime)

computes the total data average

Constant / Data Structure Detail

Structure

MsTmWin

sliding time window averager structure

Function / Macro Detail Function / Macro MsTmWinInit Format void MsTmWinInit (MsTmWin* pWin, clocktype sSize, int nSlot, double weight, clocktype theTime) Parameters: initialize time sliding window with the given parameters
pWin

- pointer to the time sliding window - sliding window slot size - sliding window number of slots - weight for average computation - the current time

sSize nSlot

weight

theTime

Returns:
void

- None

MsTmWinInit

void MsTmWinInit (MsTmWin* pWin, clocktype sSize, int nSlot, double weight, clocktype theTime) Parameters:

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SLIDING-WINDOW.html[5/24/2011 12:40:08 PM]

SLIDING-WINDOW

resets time sliding window with the given parameters

pWin

- pointer to the time sliding window - sliding window slot size - sliding window number of slots - weight for average computation - the current time

sSize nSlot

weight

theTime

Returns:
void

- None

MsTmWinNewData

void MsTmWinNewData (MsTmWin* pWin, double data, clocktype theTime) Parameters:

updates time sliding window with the given new data

pWin data

- pointer to the time sliding window - new data - the current time

pWin

- pointer to the time sliding window - the current time

theTime

Returns:
double

- the data average of the window

MsTmWinTotalSum

double MsTmWinTotalSum (MsTmWin* pWin, clocktype theTime) Parameters:

computes the total data sum

pWin

- pointer to the time sliding window - the current time

theTime

Returns:
double

- the total data sum

MsTmWinTotalAvg

double MsTmWinTotalAvg (MsTmWin* pWin, clocktype theTime) Parameters:

computes the total data average

pWin

- pointer to the time sliding window - the current time

theTime

Returns:
double

- the total data average

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/SLIDING-WINDOW.html[5/24/2011 12:40:08 PM]

TRACE

EXata 2.2 API Specification

TRACE
This file describes data structures and functions used for packet tracing. Constant / Data Structure Summary Type
CONSTANT

Name
MAX_TRACE_LENGTH

Buffer for an XML trace record.

CONSTANT TRACE_STRING_LENGTH

Generic maximum length of a string. The maximum length of any line in the input file is 3x this value.
ENUMERATION TraceDirectionType

Different direction of packet tracing

ENUMERATION PacketActionType

Different types of action on packet

ENUMERATION PacketDirection

Direction of packet with respect to the node

ENUMERATION TraceLayerType

Keeps track of which layer is being traced.

ENUMERATION TraceIncludedHeadersType

Specifies if included headers are output.

ENUMERATION PacketActionCommentType

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRACE.html[5/24/2011 12:40:23 PM]

TRACE

Gives specific comments on the packet action here packet drop.

ENUMERATION TraceProtocolType

Enlisting all the possible traces

STRUCT TraceData

Keeps track of which protocol is being traced.

STRUCT PktQueue

Gives details of the packet queue

STRUCT ActionData

Keeps track of protocol action

Function / Macro Summary Return Type

void

Summary
TRACE_Initialize(Node* node, const NodeInput* nodeInput)

Initialize necessary trace information before simulation starts.

BOOL TRACE_IsTraceAll(Node* node)

Determine if TRACE-ALL is enabled from configuration file.

void TRACE_PrintTrace(Node* node, Message* message, TraceLayerType layerType, PacketDirection pktDirection, ActionData* actionData)

Print trace information to file. To be used with Tracer.

void TRACE_PrintTrace(Node* node, Message* message, TraceLayerType layerType, PacketDirection pktDirection, ActionData* actionData, NetworkType netType)

Print trace information to file. To be used with Tracer.

void TRACE_EnableTraceXML(Node* node, TraceProtocolType protocol, char* protocolName, TracePrintXMLFn xmlPrintFn, BOOL writeMap)

Enable XML trace for a particular protocol.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRACE.html[5/24/2011 12:40:23 PM]

TRACE

void

TRACE_EnableTraceXML(Node* node, TraceProtocolType protocol, char* protocolName, TracePrintXMLFn xmlPrintFn, BOOL writeMap)

Enable XML trace for a particular protocol.

void TRACE_DisableTraceXML(Node* node, TraceProtocolType protocol, char* protocolName, BOOL writeMap)

Disable XML trace for a particular protocol.

void TRACE_WriteToBufferXML(Node* node, char* buf)

Write trace information to a buffer, which will then be printed to a file.

void TRACE_WriteTraceHeader(FILE* fp)

Write trace header information to the partition's trace file

Different types of action on packet PacketDirection

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRACE.html[5/24/2011 12:40:23 PM]

TRACE

Structure

Gives details of the packet queue ActionData

Keeps track of protocol action

Function / Macro Detail Function / Macro TRACE_Initialize Format void TRACE_Initialize (Node* node, const NodeInput* nodeInput) Parameters: Initialize necessary trace information before simulation starts.
node

- this node - access to configuration file

nodeInput

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRACE.html[5/24/2011 12:40:23 PM]

TRACE

Returns:
void

- NULL

TRACE_IsTraceAll

BOOL TRACE_IsTraceAll (Node* node) Parameters:

Determine if TRACE-ALL is enabled from configuration file.

node

- this node

Returns:
BOOL

- TRUE if TRACE-ALL is enabled, FALSE otherwise.

TRACE_PrintTrace

void TRACE_PrintTrace (Node* node, Message* message, TraceLayerType layerType, PacketDirection pktDirection, ActionData* actionData) Parameters:

Print trace information to file. To be used with Tracer.

node

- this node - Packet to print trace info from. - Layer that is calling this function. - If the packet is coming out of

message

layerType

pktDirection actionData

- more details about the packet action

Returns:
void

- NULL

TRACE_PrintTrace

void TRACE_PrintTrace (Node* node, Message* message, TraceLayerType layerType, PacketDirection pktDirection, ActionData* actionData, NetworkType netType) Parameters:

Print trace information to file. To be used with Tracer.

node

- this node - Packet to print trace info from. - Layer that is calling this function. - If the packet is coming out of

message

layerType

pktDirection actionData netType

- more details about the packet action

- The network type.

Returns:
void

- NULL

TRACE_EnableTraceXML

void TRACE_EnableTraceXML (Node* node, TraceProtocolType protocol, char* protocolName,

protocolName writeMap

- flag to print protocol ID map

TRANSPORT LAYER

EXata 2.2 API Specification

TRANSPORT LAYER
This file describes data structures and functions used by the Tansport Layer. Constant / Data Structure Summary Type
CONSTANT

Name
TRANSPORT_DELAY

Delay to process a packet in transport layer

ENUMERATION TransportProtocol

Enlisting different transport layer protocol

STRUCT TransportData

Main data structure of transport layer

Constant / Data Structure Detail

Constant

TRANSPORT_DELAY (1 * MICRO_SECOND)

Enumeration

Delay to process a packet in transport layer TransportProtocol

Structure

Enlisting different transport layer protocol TransportData

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRANSPORT LAYER.html[5/24/2011 12:40:46 PM]

TRANSPORT LAYER

Main data structure of transport layer

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/TRANSPORT LAYER.html[5/24/2011 12:40:46 PM]

USER

EXata 2.2 API Specification

USER
This file describes data structures and functions used by the User Layer. Constant / Data Structure Summary Type
CONSTANT

Name
USER_PHONE_STARTUP_DELAY

Delay from a cellphone is powered on until it can start working.

CONSTANT USER_INCREASE_DISSATISFACTION

The step value that the user dissatisfaction degree is increased each time.
CONSTANT USER_CECREASE_DISSATISFACTION

The step value that the user dissatisfaction degree is decreased each time.
ENUMERATION UserApplicationStatus

Status of an user application session.

STRUCT UserAppInfo

Data structure stores information of one user application session.

STRUCT UserStatus

Data structure stores statuses of a user

STRUCT struct_user_str

Data structure stores information of a user

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/USER.html[5/24/2011 12:41:14 PM]

USER

Function / Macro Summary Return Type

void

Summary
USER_HandleCallUpdate(Node* node, UserApplicationStatus appStatus)

Reaction to the status change of an application session

void USER_HandleUserLayerEvent(Node* node, Message* msg)

Handle messages and events for user layer

void USER_SetTrafficPattern(Node* node)

Set a user's traffic pattern based on its profile.

void USER_SetApplicationArrival(Node* node)

Schedule an application arrival time.

Constant / Data Structure Detail

Constant

USER_PHONE_STARTUP_DELAY 5S

Constant

Delay from a cellphone is powered on until it can start working. USER_INCREASE_DISSATISFACTION 0.1

Constant

The step value that the user dissatisfaction degree is increased each time. USER_CECREASE_DISSATISFACTION -0.1

Enumeration

The step value that the user dissatisfaction degree is decreased each time. UserApplicationStatus

Structure

Status of an user application session. UserAppInfo

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/USER.html[5/24/2011 12:41:14 PM]

USER

Structure

Data structure stores information of one user application session. UserStatus

void USER_SetApplicationArrival (Node* node)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/USER.html[5/24/2011 12:41:14 PM]

USER

Parameters: Schedule an application arrival time.

node

- Pointer to node.

Returns:
void

- NULL

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/USER.html[5/24/2011 12:41:14 PM]

WALLCLOCK

EXata 2.2 API Specification

WALLCLOCK
This file describes methods of the WallClock class whose primary use is to keep track of the amount of real time that has passed during the simulation. Function / Macro Summary Return Type
BOOL

Summary
WallClock( void)

This method returns true if the WallClock is currently in the paused state.
double WallClock()

Return the real time multiple

void WallClock( void)

Pausing of the WallClock can be disabled by any external interface ambassador. Permission to pause is all or nothing, so if any external interface disables pause, no pausing is allowed. As an example, a simulation using IPNE and HLA is run. If the IPNE code disables pausing, then HLA won't be able to pause the WallClock or in other words the wall clock's value for time just keeps running.
void WallClock( void)

Allows pausing of the WallClock

double WallClock( void)

Get the amount of time, in seconds, spent paused.

Function / Macro Detail Function / Macro WallClock Format BOOL WallClock ( void)

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/WALLCLOCK.html[5/24/2011 12:41:26 PM]

WALLCLOCK

Parameters: This method returns true if the WallClock is currently in the paused state.
void

- None

void

- None

Returns:
void

- None

WallClock

double WallClock ( void) Parameters:

Get the amount of time, in seconds, spent paused.

void

- None

Returns:
double

- The amount of time paused, in seconds.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/WALLCLOCK.html[5/24/2011 12:41:26 PM]

WALLCLOCK

EXata is a Registered Trademark of Scalable Network Technologies.

file:///Z|/EXata%20Documentation/EXata%202.2/API%20Reference/API/WALLCLOCK.html[5/24/2011 12:41:26 PM]

Notes Informatica
100% (3)
Notes Informatica
121 pages
Syllabus CM1010 ITP2
No ratings yet
Syllabus CM1010 ITP2
6 pages
Software Design Document (SDD) Template: IEEE STD 1016 1998
No ratings yet
Software Design Document (SDD) Template: IEEE STD 1016 1998
7 pages
Aurora Cidr03
No ratings yet
Aurora Cidr03
12 pages
QualNet 5.2 APIReferenceGuide
No ratings yet
QualNet 5.2 APIReferenceGuide
642 pages
Computer Lab Maintenance
70% (10)
Computer Lab Maintenance
44 pages
Tableau interview questions
No ratings yet
Tableau interview questions
21 pages
Web SQL Database
No ratings yet
Web SQL Database
32 pages
T306-08 Reports - RevE
No ratings yet
T306-08 Reports - RevE
28 pages
Software Design Description For: COMSATS University Islamabad, Sahiwal Campus - Pakistan
No ratings yet
Software Design Description For: COMSATS University Islamabad, Sahiwal Campus - Pakistan
8 pages
modular_arch_programmer_guide
No ratings yet
modular_arch_programmer_guide
10 pages
Software Design Document (SDD) Template: For The Implementation Phase. Software System Will Be Structured
No ratings yet
Software Design Document (SDD) Template: For The Implementation Phase. Software System Will Be Structured
6 pages
System Design Description Template
No ratings yet
System Design Description Template
18 pages
ASP Unit3
No ratings yet
ASP Unit3
20 pages
Chapter 3 ETAP User Guide 7 5 2
No ratings yet
Chapter 3 ETAP User Guide 7 5 2
75 pages
Ab Initio Basic Turorial
No ratings yet
Ab Initio Basic Turorial
22 pages
MAN2 Designer
No ratings yet
MAN2 Designer
16 pages
Glossary: Click Handler Confirm Handler Display Handler Network Packet Chart
No ratings yet
Glossary: Click Handler Confirm Handler Display Handler Network Packet Chart
23 pages
JavaDoc Cheat Sheet
No ratings yet
JavaDoc Cheat Sheet
5 pages
Informatica8.6 New Features
No ratings yet
Informatica8.6 New Features
5 pages
Chapter - 03 - Review of Basic Data
No ratings yet
Chapter - 03 - Review of Basic Data
92 pages
Qns
No ratings yet
Qns
69 pages
Top 100 Tableau Interview Questions and Answers (2021)
100% (1)
Top 100 Tableau Interview Questions and Answers (2021)
18 pages
Software Architecture and Design Documentation Template
No ratings yet
Software Architecture and Design Documentation Template
7 pages
Web Technologies Ans
No ratings yet
Web Technologies Ans
10 pages
Data Mapper Guide-1.6.2
No ratings yet
Data Mapper Guide-1.6.2
108 pages
Production Package System
No ratings yet
Production Package System
26 pages
UNIT-V Data Programming
No ratings yet
UNIT-V Data Programming
16 pages
Note
No ratings yet
Note
9 pages
Creating An Altair Flux Project
No ratings yet
Creating An Altair Flux Project
33 pages
UNIT-V Data Programming
No ratings yet
UNIT-V Data Programming
16 pages
UNIT 3
No ratings yet
UNIT 3
20 pages
Unit I
100% (1)
Unit I
32 pages
SBL Python LAB Manual by NY Expt. No. 6.docx
No ratings yet
SBL Python LAB Manual by NY Expt. No. 6.docx
5 pages
How To Create and Use Macro
No ratings yet
How To Create and Use Macro
18 pages
4 Dbms
0% (1)
4 Dbms
54 pages
Intro To
No ratings yet
Intro To
53 pages
Transformation Engine Manual - en - v0.81
No ratings yet
Transformation Engine Manual - en - v0.81
11 pages
maxDPUTools Ch07 Using Import Export Utilities
No ratings yet
maxDPUTools Ch07 Using Import Export Utilities
11 pages
Bank Management System
100% (7)
Bank Management System
36 pages
4.6.3 Diagrams: Therefore, One Component Can Appear in Several Diagrams
No ratings yet
4.6.3 Diagrams: Therefore, One Component Can Appear in Several Diagrams
3 pages
How Hibernate Works
No ratings yet
How Hibernate Works
6 pages
Gupta Sqlwindows Function Reference
100% (1)
Gupta Sqlwindows Function Reference
338 pages
Foreign Trading System
No ratings yet
Foreign Trading System
19 pages
Design Doc Sample
No ratings yet
Design Doc Sample
4 pages
Chapter3 2
No ratings yet
Chapter3 2
14 pages
SQL
No ratings yet
SQL
53 pages
Sys Design
No ratings yet
Sys Design
8 pages
Customization Guide
No ratings yet
Customization Guide
26 pages
VTS2
No ratings yet
VTS2
26 pages
Glossary: AND OR Select Name From Artist Where School ABSTRACT' AND Medium Watercolor'
No ratings yet
Glossary: AND OR Select Name From Artist Where School ABSTRACT' AND Medium Watercolor'
12 pages
Computer Monitoring System For EE Faculty: by Yaroslav Ross and Denis Zakrevsky Supervisor: Viktor Kulikov
No ratings yet
Computer Monitoring System For EE Faculty: by Yaroslav Ross and Denis Zakrevsky Supervisor: Viktor Kulikov
36 pages
C#-Unit5
No ratings yet
C#-Unit5
9 pages
DSS 12 S4 03 Design Specification
No ratings yet
DSS 12 S4 03 Design Specification
48 pages
Data Mapper
No ratings yet
Data Mapper
104 pages
User Manual Matlab Aerospace Toolbox
0% (1)
User Manual Matlab Aerospace Toolbox
88 pages
P P P P P
No ratings yet
P P P P P
10 pages
L1 - Introduction To ADTs
No ratings yet
L1 - Introduction To ADTs
22 pages
DBMS
100% (1)
DBMS
29 pages
Ian Talks Python A-Z
From Everand
Ian Talks Python A-Z
Ian Eress
No ratings yet
Java / J2EE Interview Questions You'll Most Likely Be Asked
From Everand
Java / J2EE Interview Questions You'll Most Likely Be Asked
Vibrant Publishers
No ratings yet
Distributed Systems
No ratings yet
Distributed Systems
1 page
PES University, Bengaluru
No ratings yet
PES University, Bengaluru
8 pages
Employee Data Using Doubly Linked List
No ratings yet
Employee Data Using Doubly Linked List
5 pages
Ip Project Final
No ratings yet
Ip Project Final
18 pages
Ansible Notes
No ratings yet
Ansible Notes
19 pages
Check 0
No ratings yet
Check 0
11 pages
314317 Java Programming
100% (1)
314317 Java Programming
8 pages
Understanding DDD
No ratings yet
Understanding DDD
8 pages
EDA Cheatsheet - Class Note
No ratings yet
EDA Cheatsheet - Class Note
29 pages
School of Information Technology and Engineering: Declaration by The Candidate
No ratings yet
School of Information Technology and Engineering: Declaration by The Candidate
4 pages
Electricity Bill Management System: Software Description A. Java
No ratings yet
Electricity Bill Management System: Software Description A. Java
7 pages
TE Comp - Web Technology
No ratings yet
TE Comp - Web Technology
1 page
C++ IOS and Manipulator
No ratings yet
C++ IOS and Manipulator
41 pages
Docker Intro
No ratings yet
Docker Intro
3 pages
Add Editable Customer Fields To ME51n ME52n ME53n
100% (2)
Add Editable Customer Fields To ME51n ME52n ME53n
4 pages
Unit - Ii Decision Making, Branching, Looping Arrays & Strings
No ratings yet
Unit - Ii Decision Making, Branching, Looping Arrays & Strings
36 pages
Nagamani New Resume&-5
No ratings yet
Nagamani New Resume&-5
2 pages
ALV With IDA (In Detail)
No ratings yet
ALV With IDA (In Detail)
13 pages
Cloud Engineer Resume
100% (2)
Cloud Engineer Resume
8 pages
Complete Design Patterns: Elements of Reusable Object-Oriented Software 1st Edition - Ebook PDF PDF For All Chapters
100% (5)
Complete Design Patterns: Elements of Reusable Object-Oriented Software 1st Edition - Ebook PDF PDF For All Chapters
41 pages
Ejercicios Del Curso de C# MCTS 191354 Answers
No ratings yet
Ejercicios Del Curso de C# MCTS 191354 Answers
78 pages
Lecon Database
No ratings yet
Lecon Database
25 pages
Jntuk - Mca 5th Sem Syllabus
No ratings yet
Jntuk - Mca 5th Sem Syllabus
19 pages
cs pf
No ratings yet
cs pf
10 pages
Java OOPs Concepts
No ratings yet
Java OOPs Concepts
131 pages
Docker
No ratings yet
Docker
9 pages
API Testing
No ratings yet
API Testing
20 pages
Chowdhury Nahid
100% (1)
Chowdhury Nahid
3 pages
Assignment 1
No ratings yet
Assignment 1
4 pages