User Manual, Developers Guide and API Documentation

Aggregation.cpp

Go to the documentation of this file.

/******************************************************************************
 * WiFiMac                                                                    *
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#include <WIFIMAC/draftn/Aggregation.hpp>

#include <WNS/probe/bus/ContextProvider.hpp>
#include <WNS/probe/bus/utils.hpp>

using namespace wifimac::draftn;

STATIC_FACTORY_REGISTER_WITH_CREATOR(
    wifimac::draftn::Aggregation,
    wns::ldk::FunctionalUnit,
    "wifimac.draftn.Aggregation",
    wns::ldk::FUNConfigCreator);

STATIC_FACTORY_REGISTER_WITH_CREATOR(
    wifimac::draftn::Aggregation,
    wns::ldk::probe::Probe,
    "wifimac.draftn.Aggregation",
    wns::ldk::FUNConfigCreator);

Aggregation::Aggregation(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config_) :
    wns::ldk::concatenation::Concatenation(fun, config_),
    wns::ldk::probe::Probe(),

    managerName(config_.get<std::string>("managerName")),
    impatientTransmission(config_.get<bool>("myConfig.impatient")),
    maxDelay(config_.get<wns::simulator::Time>("myConfig.maxDelay")),
    sendNow(false),
    currentReceiver()
{
    MESSAGE_SINGLE(NORMAL, logger, "created");

    friends.manager = NULL;

    // read the localIDs from the config
    wns::probe::bus::ContextProviderCollection registry(&fun->getLayer()->getContextProviderCollection());
    for(int ii = 0; ii < config_.len("localIDs.keys()"); ++ii)
    {
        std::string key = config_.get<std::string>("localIDs.keys()",ii);
        unsigned int value  = config_.get<unsigned int>("localIDs.values()",ii);
        registry.addProvider(wns::probe::bus::contextprovider::Constant(key, value));
        MESSAGE_SINGLE(VERBOSE, logger, "Using Local IDName '"<<key<<"' with value: "<<value);
    }

    aggregationSizeFrames = wns::probe::bus::collector(registry, config_, "aggregationSizeFramesProbeName");
}


void Aggregation::onFUNCreated()
{
    MESSAGE_SINGLE(NORMAL, logger, "onFUNCreated() started");

    friends.manager = getFUN()->findFriend<wifimac::lowerMAC::Manager*>(managerName);
}

void Aggregation::processOutgoing(const wns::ldk::CompoundPtr& compound)
{
    assure(friends.manager->getFrameType(compound->getCommandPool()) != ACK, "Cannot handle ACK frames");

    if(not (this->currentCompound == wns::ldk::CompoundPtr()))
    {
        // ongoing aggregation
        assure(this->currentReceiver.isValid(), "Has something to send, but not valid receiver");

        if(friends.manager->getReceiverAddress(compound->getCommandPool()) == this->currentReceiver)
        {
            if(friends.manager->getReplyTimeout(compound->getCommandPool()) > 0)
            {
                // requires reply, close the aggregation
                this->currentEntries = this->maxEntries-1;
                MESSAGE_BEGIN(NORMAL, logger, m, "Compound to ");
                m << friends.manager->getReceiverAddress(compound->getCommandPool());
                m << " requires direct reply -> Close aggregation, fake entries to " << this->currentEntries;
                MESSAGE_END();
                // mark current compound in the same way
                friends.manager->setReplyTimeout(this->currentCompound->getCommandPool(),
                                                 friends.manager->getReplyTimeout(compound->getCommandPool()));
                sendNow = true;
            }
            // accepted compound is for the same receiver as the other ones -->
            // no differentiation
            wns::ldk::concatenation::Concatenation::processOutgoing(compound);
            if((not hasCapacity()) or impatientTransmission)
            {
                // no more capacity -> send, even if patient aggregation
                sendNow = true;
            }
        }
        else
        {
            activateCommand(compound->getCommandPool());

            // accepted compound is for a different receiver --> same as buffer
            // full
            this->nextCompound = createContainer(compound);
            this->sendNow = true;
            MESSAGE_BEGIN(NORMAL, logger, m, "Compound is for receiver ");
            m << friends.manager->getReceiverAddress(compound->getCommandPool());
            m << ", current receiver is " << this->currentReceiver;
            m << " -> No concatenation possible";
            MESSAGE_END();

            this->currentReceiver = friends.manager->getReceiverAddress(compound->getCommandPool());
        }
    }
    else
    {
        this->currentReceiver = friends.manager->getReceiverAddress(compound->getCommandPool());
        if((friends.manager->getFrameType(compound->getCommandPool()) == ACK) or impatientTransmission)
        {
            MESSAGE_BEGIN(NORMAL, logger, m, "New aggregation for receiver ");
            m << this->currentReceiver;
            m << " send impatiently";
            MESSAGE_END();

            this->sendNow = true;
        }
        else
        {
            MESSAGE_BEGIN(NORMAL, logger, m, "New aggregation for receiver ");
            m << this->currentReceiver;
            m << ", wait for more";
            MESSAGE_END();

            setTimeout(this->maxDelay);
            this->sendNow = false;
        }

        wns::ldk::concatenation::Concatenation::processOutgoing(compound);
    }
}

void
Aggregation::onTimeout()
{
    MESSAGE_SINGLE(NORMAL, logger, "Timeout for current aggregation -> send");
    sendNow = true;
    tryToSend();
}

const wns::ldk::CompoundPtr
Aggregation::hasSomethingToSend() const
{
    // wait for sendNow indication
    if(not sendNow)
    {
        return wns::ldk::CompoundPtr();
    }

    return wns::ldk::concatenation::Concatenation::hasSomethingToSend();

} // somethingToSend

wns::ldk::CompoundPtr
Aggregation::getSomethingToSend()
{
    wns::ldk::CompoundPtr it = wns::ldk::concatenation::Concatenation::getSomethingToSend();
    // reset sendNow for next aggregation
    sendNow = false;
    if(hasTimeoutSet())
    {
        cancelTimeout();
    }

    aggregationSizeFrames->put(it, getCommand(it->getCommandPool())->peer.compounds.size());

    wns::ldk::CompoundPtr lastEntry = getCommand(it->getCommandPool())->peer.compounds.back();

    MESSAGE_BEGIN(NORMAL, logger, m, "Send aggregated compound with frame exchange duration set to");
    m << friends.manager->getFrameExchangeDuration(lastEntry->getCommandPool());
    MESSAGE_END();

    // set the frame exchange duration to the value given in the last aggregated compound
    friends.manager->setFrameExchangeDuration(it->getCommandPool(),
                                              friends.manager->getFrameExchangeDuration(lastEntry->getCommandPool()));

    return(it);
}

---