User Manual, Developers Guide and API Documentation

Manager.hpp

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/>.
 *
 ******************************************************************************/

#ifndef WIFIMAC_LOWERMAC_MANAGER_HPP
#define WIFIMAC_LOWERMAC_MANAGER_HPP

#include <WIFIMAC/convergence/PhyMode.hpp>
#include <WIFIMAC/convergence/PhyUser.hpp>
#include <WIFIMAC/FrameType.hpp>

#include <WNS/logger/Logger.hpp>

#include <WNS/ldk/Command.hpp>
#include <WNS/ldk/fu/Plain.hpp>
#include <WNS/ldk/Processor.hpp>

#include <WNS/service/dll/Address.hpp>

#include <DLL/Layer2.hpp>
#include <DLL/UpperConvergence.hpp>

namespace wifimac { namespace convergence {
    class PhyUser;
}}

namespace wifimac { namespace lowerMAC {

    class ManagerCommand :
        public wifimac::IKnowsFrameTypeCommand
    {
    public:
        struct {
            wns::simulator::Time expirationTime;

            wns::simulator::Time replyTimeout;
        } local;

        struct {
            wifimac::FrameType type;
            wifimac::convergence::PhyMode phyMode;

            wns::simulator::Time frameExchangeDuration;
        } peer;

        struct { } magic;

        ManagerCommand()
            {
                peer.type = DATA;
                peer.frameExchangeDuration = 0.0;
                local.replyTimeout = 0.0;
            }

        FrameType getFrameType()
            {
                return peer.type;
            }
        bool isPreamble() const
            {
                return peer.type == PREAMBLE;
            }

        wifimac::convergence::PhyMode getPhyMode() const
        {
            return this->peer.phyMode;
        }
    };

    class Manager :
        public wns::ldk::fu::Plain<Manager, ManagerCommand>,
        public wns::ldk::Processor<Manager>
    {
    public:
        Manager(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);

        virtual
        ~Manager();

        void processIncoming(const wns::ldk::CompoundPtr& compound);

        void processOutgoing(const wns::ldk::CompoundPtr& compound);

        wifimac::convergence::PhyUser*
        getPhyUser();

        dll::ILayer2::StationType
        getStationType() const;

        wns::service::dll::UnicastAddress
        getMACAddress() const;

        void
        associateWith(wns::service::dll::UnicastAddress svrAddress);

        wns::service::dll::UnicastAddress
        getAssociatedTo() const;

        wns::ldk::CommandPool*
        createReply(const wns::ldk::CommandPool* original) const;

        wns::ldk::CompoundPtr
        createCompound(const wns::service::dll::UnicastAddress transmitterAddress,
                       const wns::service::dll::UnicastAddress receiverAddress,
                       const FrameType type,
                       const wns::simulator::Time frameExchangeDuration,
                       const wns::simulator::Time replyTimeout = 0.0);

        wns::service::dll::UnicastAddress
        getTransmitterAddress(const wns::ldk::CommandPool* commandPool) const;

        wns::service::dll::UnicastAddress
        getReceiverAddress(const wns::ldk::CommandPool* commandPool) const;

        bool
        isForMe(const wns::ldk::CommandPool* commandPool) const;

        wifimac::FrameType
        getFrameType(const wns::ldk::CommandPool* commandPool) const;

        void
        setFrameType(const wns::ldk::CommandPool* commandPool, const FrameType type);

        wns::simulator::Time
        getFrameExchangeDuration(const wns::ldk::CommandPool* commandPool) const;

        void
        setFrameExchangeDuration(const wns::ldk::CommandPool* commandPool, const wns::simulator::Time duration);

        wifimac::convergence::PhyMode
        getPhyMode(const wns::ldk::CommandPool* commandPool) const;

        void
        setPhyMode(const wns::ldk::CommandPool* commandPool, const wifimac::convergence::PhyMode phyMode);

        wns::simulator::Time
        getReplyTimeout(const wns::ldk::CommandPool* commandPool) const;

        void
        setReplyTimeout(const wns::ldk::CommandPool* commandPool, wns::simulator::Time replyTimeout);

        unsigned int
        getNumAntennas() const;

        bool
        lifetimeExpired(const wns::ldk::CommandPool* commandPool) const;

        wns::simulator::Time
        getExpirationTime(const wns::ldk::CommandPool* commandPool) const;


    private:
        virtual void
        onFUNCreated();

        const wns::pyconfig::View config_;
        wns::logger::Logger logger_;

        const wns::simulator::Time maximumACKDuration;

        const wns::simulator::Time sifsDuration;

        const wns::service::dll::UnicastAddress myMACAddress_;

        const std::string ucName_;

        const unsigned int numAntennas;

        const wns::simulator::Time msduLifetimeLimit;

        wns::service::dll::UnicastAddress associatedTo;

        struct Friends
        {
            dll::UpperConvergence* upperConvergence;
            wifimac::convergence::PhyUser* phyUser;
        } friends;
    };
} // lowerMAC
} // wifimac

#endif // WIFIMAC_LOWERMAC_MANAGER_HPP

---