RINASim  October 2016
Documentation of framework for OMNeT++
Address Class Reference

Address class holds IPC Process identification. More...

#include <Address.h>

Public Member Functions

 Address ()
 Constructor of blank Address. More...
 
 Address (std::string composite)
 Address constructor from unique APN. More...
 
 Address (APN apname)
 
 Address (const char *ipcaddr, const char *difnam)
 Address constructor from both IPC address and DIF name. More...
 
virtual ~Address ()
 Destructor assigning default values. More...
 
bool operator== (const Address &other) const
 
bool operator< (const Address &other) const
 
std::string info () const
 Info text output suitable for << string streams and WATCH. More...
 
bool isUnspecified () const
 Checks whether a given Address is unspecified which means that it has empty attributes. More...
 
const APNgetApn () const
 Getter of unique APN which is initialized during object construction. More...
 
const DAPgetDifName () const
 Getter of common DIF name. More...
 
void setDifName (const DAP &difName)
 Setter of common DIF name. More...
 
const APNgetIpcAddress () const
 Getter of IPC Process address which should be unambiguous within DIF. More...
 
void setIpcAddress (const APN &ipcAddress)
 Setter of IPC Process address which should be unambiguous within DIF. More...
 

Static Public Attributes

static const Address UNSPECIFIED_ADDRESS
 

Protected Attributes

APN ipcAddress
 IPC Process address represented by APN. More...
 
DAP difName
 Commong DIF name represented by DAP. More...
 
APN apname
 Concatenation of IPC Process address and DIF name represented as APN. More...
 

Detailed Description

Address class holds IPC Process identification.

Class contains three attributes: IPC address identifier, common DIF name and concatenation of previous two that should be used as unique APN.

Authors
Vladimir Vesely (ivese.nosp@m.ly@f.nosp@m.it.vu.nosp@m.tbr..nosp@m.cz)
Date
Last refactorized and documented on 2014-10-29

Definition at line 42 of file Address.h.

Constructor & Destructor Documentation

Address::Address ( )

Constructor of blank Address.

Definition at line 27 of file Address.cc.

Address::Address ( std::string  composite)

Address constructor from unique APN.

Parameters
compositeExpected is a string with following syntax <ipcaddress>_<difname>

Definition at line 31 of file Address.cc.

Address::Address ( APN  apname)

Definition at line 141 of file Address.cc.

Address::Address ( const char *  ipcaddr,
const char *  difnam 
)

Address constructor from both IPC address and DIF name.

Parameters
ipcaddrIPC Process address unambiguos inside a given DIF
difnamDIF name that this IPC Process is a member

Definition at line 58 of file Address.cc.

Address::~Address ( )
virtual

Destructor assigning default values.

Definition at line 66 of file Address.cc.

Member Function Documentation

const APN & Address::getApn ( ) const

Getter of unique APN which is initialized during object construction.

Returns
Returns APN in form of <ipcaddress>_<difname>

Definition at line 119 of file Address.cc.

Referenced by RA::bindNFlowToNM1Flow(), RA::createNM1Flow(), NFlowTable::findEntriesAffectedByMgmt(), NFlowTable::findEntriesByDstNeighborAndFwd(), NFlowTable::findEntryByDstAddressAndFwd(), FA::getAddressFromDa(), Infection::Flow::getPDU(), MockEFCPI::handleMessage(), Enrollment::initialize(), DAFEnrollment::initialize(), StaticGenerator::StaticGenerator::insertedFlow(), Enrollment::insertStateTableEntry(), Flow::isManagementFlowLocalToIPCP(), RA::postNFlowAllocation(), FA::receiveAllocateRequest(), FA::receiveMgmtAllocateRequest(), LisDAFEnrollmentNotifierRcvCACE::receiveSignal(), LisDAFEnrollmentNotifierRcvEnrollCACE::receiveSignal(), LisDAFEnrollmentNotifierStaEnrolReq::receiveSignal(), LisDAFEnrollmentNotifierStaEnrolRes::receiveSignal(), LisFAAllocFinMgmt::receiveSignal(), LisRIBDAllReqFromFai::receiveSignal(), LisDAFEnrollmentNotifierStoEnrolReq::receiveSignal(), LisFACreFloPosi::receiveSignal(), LisDAFEnrollmentNotifierStoEnrolRes::receiveSignal(), LisDAFEnrollmentNotifierStaOperReq::receiveSignal(), LisDAFEnrollmentNotifierStaOperRes::receiveSignal(), LisFAICreResPosiNminusOne::receiveSignal(), LisFAICreResNegaNminusOne::receiveSignal(), Enrollment::receiveStartEnrollmentRequest(), DAFEnrollment::receiveStartEnrollmentRequest(), Enrollment::receiveStartEnrollmentResponse(), DAFEnrollment::receiveStartEnrollmentResponse(), Enrollment::receiveStopEnrollmentRequest(), DAFEnrollment::receiveStopEnrollmentRequest(), Enrollment::receiveStopEnrollmentResponse(), DAFEnrollment::receiveStopEnrollmentResponse(), RMT::relayPDUToPort(), and StaticGenerator::StaticGenerator::removedFlow().

const DAP & Address::getDifName ( ) const
const APN & Address::getIpcAddress ( ) const

Getter of IPC Process address which should be unambiguous within DIF.

Returns
IPC Process address

Definition at line 83 of file Address.cc.

Referenced by FA::changeDstAddresses(), NFlowTable::findEntryBySrcAddressAndFwd(), IDPerNFlow::generateIDFromFlow(), IDPerNFlow::generateOutputQueueID(), IDPerNQoSxPLen::generateOutputQueueID(), Infection::Infection::handleMessage(), FABase::initMyAddress(), MiniTable::MiniTable::insert(), QoSTable::QoSTable::insert(), SimpleTable::SimpleTable::insert(), IQoSAwareMEntries::IQoSAwareMEntries::insertedFlow(), QoSAwareMEntries::QoSAwareMEntries::insertedFlow(), HopsSingleMEntries::HopsSingleMEntries::insertedFlow(), NSPSimpleDC::VoidDCGenerator::insertedFlow(), HopsSingle1Entry::HopsSingle1Entry::insertedFlow(), HopsQoSMEntries::HopsQoSMEntries::insertedFlow(), NSPSimpleDC::SimpleDCGenerator::insertedFlow(), NSPSimpleHopMEntries::SimpleHopMEntries::insertedFlow(), NSPSimpleLatOrHopMEntries::SimpleLatOrHopMEntries::insertedFlow(), PLQoSAwareMEntries::PLQoSAwareMEntries::insertedFlow(), LatencySingleMEntries::LatencySingleMEntries::insertedFlow(), LatencySingle1Entry::LatencySingle1Entry::insertedFlow(), SimpleGenerator::SimpleGenerator::insertedFlow(), SingleDomainGenerator::SingleDomainGenerator::insertedFlow(), MSimpleGenerator::MSimpleGenerator::insertedFlow(), HierarchicalGenerator::HierarchicalGenerator::insertedFlow(), BiDomainGenerator::BiDomainGenerator::insertedFlow(), QoSDomainGenerator::QoSDomainGenerator::insertedFlow(), LatGenerator::LatGenerator::insertedFlow(), PortsLoadGenerator::insertedFlow(), FloodMiniTable::FloodMiniTable::lookup(), MiniTable::MiniTable::lookup(), MultiMiniTable::MultiMiniTable::lookup(), NSPSimpleDC::iSimpleDCForwarding::lookup(), QoSTable::QoSTable::lookup(), SimpleTable::SimpleTable::lookup(), IMultiQoSTable::IMultiQoSTable::lookup(), MultiQoSTable::MultiQoSTable::lookup(), DomainTable::DomainTable::lookup(), PrefixMatch::matchesThisIPC(), PrefixMatch::onPolicyInit(), PortsLoadLS::onPolicyInit(), MiniTable::MiniTable::remove(), SimpleTable::SimpleTable::remove(), QoSTable::QoSTable::remove(), IQoSAwareMEntries::IQoSAwareMEntries::removedFlow(), QoSAwareMEntries::QoSAwareMEntries::removedFlow(), NSPSimpleDC::SimpleDCGenerator::removedFlow(), HopsSingleMEntries::HopsSingleMEntries::removedFlow(), NSPSimpleDC::VoidDCGenerator::removedFlow(), HopsQoSMEntries::HopsQoSMEntries::removedFlow(), HopsSingle1Entry::HopsSingle1Entry::removedFlow(), NSPSimpleHopMEntries::SimpleHopMEntries::removedFlow(), NSPSimpleLatOrHopMEntries::SimpleLatOrHopMEntries::removedFlow(), PLQoSAwareMEntries::PLQoSAwareMEntries::removedFlow(), LatencySingle1Entry::LatencySingle1Entry::removedFlow(), LatencySingleMEntries::LatencySingleMEntries::removedFlow(), MSimpleGenerator::MSimpleGenerator::removedFlow(), SingleDomainGenerator::SingleDomainGenerator::removedFlow(), SimpleGenerator::SimpleGenerator::removedFlow(), HierarchicalGenerator::HierarchicalGenerator::removedFlow(), BiDomainGenerator::BiDomainGenerator::removedFlow(), QoSDomainGenerator::QoSDomainGenerator::removedFlow(), LatGenerator::LatGenerator::removedFlow(), PortsLoadGenerator::removedFlow(), Enrollment::startEnrollment(), and RMT::tracePDUEvent().

std::string Address::info ( ) const

Info text output suitable for << string streams and WATCH.

Returns
Address string representation

Definition at line 106 of file Address.cc.

Referenced by operator<<().

bool Address::isUnspecified ( ) const

Checks whether a given Address is unspecified which means that it has empty attributes.

Returns
True if it is unspecified, else returns false

Definition at line 114 of file Address.cc.

Referenced by FA::setNeighborAddresses(), and FA::setOriginalAddresses().

bool Address::operator< ( const Address other) const

LesTan operator overload

Parameters
otherAddress for comparison
Returns
Returns true if IPC address, DIF name and AP Name is smaller in this and other Address

Definition at line 95 of file Address.cc.

bool Address::operator== ( const Address other) const

Equal operator overload

Parameters
otherAddress for comparison
Returns
Returns true if IPC address, DIF name and AP Name are equal between this and other Address

Definition at line 88 of file Address.cc.

void Address::setDifName ( const DAP difName)

Setter of common DIF name.

Parameters
difNameA new DIF name value

Definition at line 78 of file Address.cc.

void Address::setIpcAddress ( const APN ipcAddress)

Setter of IPC Process address which should be unambiguous within DIF.

Parameters
ipcAddressA new IPC Process address value

Definition at line 124 of file Address.cc.

Referenced by FA::changeDstAddresses(), and Enrollment::receiveStartEnrollmentResponse().

Member Data Documentation

APN Address::apname
protected

Concatenation of IPC Process address and DIF name represented as APN.

Definition at line 143 of file Address.h.

Referenced by Address(), getApn(), operator<(), operator==(), and ~Address().

DAP Address::difName
protected

Commong DIF name represented by DAP.

Definition at line 138 of file Address.h.

Referenced by Address(), getDifName(), info(), isUnspecified(), operator<(), operator==(), setDifName(), and ~Address().

APN Address::ipcAddress
protected

IPC Process address represented by APN.

Definition at line 133 of file Address.h.

Referenced by Address(), getIpcAddress(), info(), isUnspecified(), operator<(), operator==(), setIpcAddress(), and ~Address().

const Address Address::UNSPECIFIED_ADDRESS
static

The documentation for this class was generated from the following files: