inet::ieee80211::Ieee80211MgmtAPBase Class Reference

Used in 802.11 infrastructure mode: abstract base class for management frame handling for access points (APs). More...

#include <Ieee80211MgmtAPBase.h>

Inheritance diagram for inet::ieee80211::Ieee80211MgmtAPBase:

Public Types
enum	EncapDecap { ENCAP_DECAP_TRUE = 1, ENCAP_DECAP_FALSE, ENCAP_DECAP_ETH }

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int) override
virtual void	distributeReceivedDataFrame (Ieee80211DataFrame *frame)
	Utility function for APs: sends back a data frame we received from a STA to the wireless LAN, after tweaking fromDS/toDS bits and shuffling addresses as needed. More...
virtual Ieee80211DataFrame *	encapsulate (cPacket *msg)
	Utility function for handleUpperMessage() More...
virtual Ieee80211DataFrame *	convertFromEtherFrame (EtherFrame *ethframe)
	Utility function: converts EtherFrame to Ieee80211Frame. More...
virtual EtherFrame *	convertToEtherFrame (Ieee80211DataFrame *frame)
	Utility function: converts Ieee80211Frame to EtherFrame. More...
virtual void	sendToUpperLayer (Ieee80211DataFrame *frame)
	Utility function: send a frame to upperLayerOut. More...
Protected Member Functions inherited from inet::ieee80211::Ieee80211MgmtBase
virtual void	handleMessage (cMessage *msg) override
	Dispatches incoming messages to handleTimer(), handleUpperMessage() or processFrame(). More...
virtual void	handleTimer (cMessage *frame)=0
	Should be redefined to deal with self-messages. More...
virtual void	handleUpperMessage (cPacket *msg)=0
	Should be redefined to encapsulate and enqueue msgs from higher layers. More...
virtual void	handleCommand (int msgkind, cObject *ctrl)=0
	Should be redefined to handle commands from the "agent" (if present) More...
virtual void	sendDown (cPacket *frame)
	Utility method for implementing handleUpperMessage(): send message to MAC. More...
virtual void	dropManagementFrame (Ieee80211ManagementFrame *frame)
	Utility method to dispose of an unhandled frame. More...
virtual void	sendUp (cMessage *msg)
	Utility method: sends the packet to the upper layer. More...
virtual void	processFrame (Ieee80211DataOrMgmtFrame *frame)
	Dispatch to frame processing methods according to frame type. More...
virtual void	handleDataFrame (Ieee80211DataFrame *frame)=0
virtual void	handleAuthenticationFrame (Ieee80211AuthenticationFrame *frame)=0
virtual void	handleDeauthenticationFrame (Ieee80211DeauthenticationFrame *frame)=0
virtual void	handleAssociationRequestFrame (Ieee80211AssociationRequestFrame *frame)=0
virtual void	handleAssociationResponseFrame (Ieee80211AssociationResponseFrame *frame)=0
virtual void	handleReassociationRequestFrame (Ieee80211ReassociationRequestFrame *frame)=0
virtual void	handleReassociationResponseFrame (Ieee80211ReassociationResponseFrame *frame)=0
virtual void	handleDisassociationFrame (Ieee80211DisassociationFrame *frame)=0
virtual void	handleBeaconFrame (Ieee80211BeaconFrame *frame)=0
virtual void	handleProbeRequestFrame (Ieee80211ProbeRequestFrame *frame)=0
virtual void	handleProbeResponseFrame (Ieee80211ProbeResponseFrame *frame)=0
virtual void	start ()
	lifecycle support More...
virtual void	stop ()

Protected Attributes
bool	isConnectedToHL
EncapDecap	encapDecap
Protected Attributes inherited from inet::ieee80211::Ieee80211MgmtBase
MACAddress	myAddress
bool	isOperational
long	numDataFramesReceived
long	numMgmtFramesReceived
long	numMgmtFramesDropped

Additional Inherited Members
Public Member Functions inherited from inet::ieee80211::Ieee80211MgmtBase
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Detailed Description

Used in 802.11 infrastructure mode: abstract base class for management frame handling for access points (APs).

This class extends Ieee80211MgmtBase with utility functions that are useful for implementing AP functionality.

Author

Andras Varga

Member Enumeration Documentation

enum inet::ieee80211::Ieee80211MgmtAPBase::EncapDecap

Enumerator
ENCAP_DECAP_TRUE
ENCAP_DECAP_FALSE
ENCAP_DECAP_ETH

{ ENCAP_DECAP_TRUE = 1, ENCAP_DECAP_FALSE, ENCAP_DECAP_ETH } EncapDecap;

Member Function Documentation

Ieee80211DataFrame * inet::ieee80211::Ieee80211MgmtAPBase::convertFromEtherFrame ( EtherFrame *  ethframe )

protectedvirtual

Utility function: converts EtherFrame to Ieee80211Frame.

This is needed because MACRelayUnit which we use for LAN bridging functionality deals with EtherFrames.

Referenced by encapsulate().

{
#ifdef WITH_ETHERNET
    // create new frame
    Ieee80211DataFrameWithSNAP *frame = new Ieee80211DataFrameWithSNAP(ethframe->getName());
    frame->setFromDS(true);

    // copy addresses from ethernet frame (transmitter addr will be set to our addr by MAC)
    frame->setReceiverAddress(ethframe->getDest());
    frame->setAddress3(ethframe->getSrc());

    // copy EtherType from original frame
    if (dynamic_cast<EthernetIIFrame *>(ethframe))
        frame->setEtherType(((EthernetIIFrame *)ethframe)->getEtherType());
    else if (dynamic_cast<EtherFrameWithSNAP *>(ethframe))
        frame->setEtherType(((EtherFrameWithSNAP *)ethframe)->getLocalcode());
    else
        throw cRuntimeError("Unaccepted EtherFrame type: %s, contains no EtherType", ethframe->getClassName());

    // encapsulate payload
    cPacket *payload = ethframe->decapsulate();
    if (!payload)
        throw cRuntimeError("received empty EtherFrame from upper layer");
    frame->encapsulate(payload);
    delete ethframe;

    // done
    return frame;
#else // ifdef WITH_ETHERNET
    throw cRuntimeError("INET compiled without ETHERNET feature!");
#endif // ifdef WITH_ETHERNET
}

EtherFrame * inet::ieee80211::Ieee80211MgmtAPBase::convertToEtherFrame ( Ieee80211DataFrame *  frame )

protectedvirtual

Utility function: converts Ieee80211Frame to EtherFrame.

This is needed because MACRelayUnit which we use for LAN bridging functionality deals with EtherFrames.

Referenced by sendToUpperLayer().

{
#ifdef WITH_ETHERNET
    Ieee80211DataFrameWithSNAP *frame = check_and_cast<Ieee80211DataFrameWithSNAP *>(frame_);

    // create a matching ethernet frame
    EthernetIIFrame *ethframe = new EthernetIIFrame(frame->getName());    //TODO option to use EtherFrameWithSNAP instead
    ethframe->setDest(frame->getAddress3());
    ethframe->setSrc(frame->getTransmitterAddress());
    ethframe->setEtherType(frame->getEtherType());
    ethframe->setByteLength(ETHER_MAC_FRAME_BYTES);

    // encapsulate the payload in there
    cPacket *payload = frame->decapsulate();
    delete frame;
    ASSERT(payload != nullptr);
    ethframe->encapsulate(payload);
    if (ethframe->getByteLength() < MIN_ETHERNET_FRAME_BYTES)
        ethframe->setByteLength(MIN_ETHERNET_FRAME_BYTES);

    // done
    return ethframe;
#else // ifdef WITH_ETHERNET
    throw cRuntimeError("INET compiled without ETHERNET feature!");
#endif // ifdef WITH_ETHERNET
}

void inet::ieee80211::Ieee80211MgmtAPBase::distributeReceivedDataFrame ( Ieee80211DataFrame *  frame )

protectedvirtual

Utility function for APs: sends back a data frame we received from a STA to the wireless LAN, after tweaking fromDS/toDS bits and shuffling addresses as needed.

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleDataFrame().

{
    // adjust toDS/fromDS bits, and shuffle addresses
    frame->setToDS(false);
    frame->setFromDS(true);

    // move destination address to address1 (receiver address),
    // and fill address3 with original source address;
    // sender address (address2) will be filled in by MAC
    ASSERT(!frame->getAddress3().isUnspecified());
    frame->setReceiverAddress(frame->getAddress3());
    frame->setAddress3(frame->getTransmitterAddress());

    sendDown(frame);
}

Ieee80211DataFrame * inet::ieee80211::Ieee80211MgmtAPBase::encapsulate ( cPacket *  msg )

protectedvirtual

Utility function for handleUpperMessage()

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleUpperMessage().

{
    switch (encapDecap) {
        case ENCAP_DECAP_ETH:
#ifdef WITH_ETHERNET
            return convertFromEtherFrame(check_and_cast<EtherFrame *>(msg));
#else // ifdef WITH_ETHERNET
            throw cRuntimeError("INET compiled without ETHERNET feature, but the 'encapDecap' parameter is set to 'eth'!");
#endif // ifdef WITH_ETHERNET
            break;

        case ENCAP_DECAP_TRUE: {
            Ieee802Ctrl *ctrl = check_and_cast<Ieee802Ctrl *>(msg->removeControlInfo());
            Ieee80211DataFrameWithSNAP *frame = new Ieee80211DataFrameWithSNAP(msg->getName());
            frame->setFromDS(true);

            // copy addresses from ethernet frame (transmitter addr will be set to our addr by MAC)
            frame->setAddress3(ctrl->getSrc());
            frame->setReceiverAddress(ctrl->getDest());
            frame->setEtherType(ctrl->getEtherType());
            int up = ctrl->getUserPriority();
            if (up >= 0) {
                // make it a QoS frame, and set TID
                frame->setType(ST_DATA_WITH_QOS);
                frame->addBitLength(QOSCONTROL_BITS);
                frame->setTid(up);
            }
            delete ctrl;

            // encapsulate payload
            frame->encapsulate(msg);
            return frame;
        }
        break;

        case ENCAP_DECAP_FALSE:
            return check_and_cast<Ieee80211DataFrame *>(msg);
            break;

        default:
            throw cRuntimeError("Unknown encapDecap value: %d", encapDecap);
            break;
    }
    return nullptr;
}

void inet::ieee80211::Ieee80211MgmtAPBase::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::ieee80211::Ieee80211MgmtBase.

Reimplemented in inet::ieee80211::Ieee80211MgmtAP, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::initialize(), and inet::ieee80211::Ieee80211MgmtAP::initialize().

{
    Ieee80211MgmtBase::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        isConnectedToHL = gate("upperLayerOut")->getPathEndGate()->isConnected();
        const char *encDec = par("encapDecap").stringValue();
        if (!strcmp(encDec, "true"))
            encapDecap = ENCAP_DECAP_TRUE;
        else if (!strcmp(encDec, "false"))
            encapDecap = ENCAP_DECAP_FALSE;
        else if (!strcmp(encDec, "eth"))
            encapDecap = ENCAP_DECAP_ETH;
        else
            throw cRuntimeError("Unknown encapDecap parameter value: '%s'! Must be 'true','false' or 'eth'.", encDec);

        WATCH(isConnectedToHL);
    }
}

virtual int inet::ieee80211::Ieee80211MgmtAPBase::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented from inet::ieee80211::Ieee80211MgmtBase.

Reimplemented in inet::ieee80211::Ieee80211MgmtAP, and inet::ieee80211::Ieee80211MgmtAPSimplified.

{ return NUM_INIT_STAGES; }

void inet::ieee80211::Ieee80211MgmtAPBase::sendToUpperLayer ( Ieee80211DataFrame *  frame )

protectedvirtual

Utility function: send a frame to upperLayerOut.

If convertToEtherFrameFlag is true, converts the given frame to EtherFrame, deleting the original frame, and send the converted frame. This function is needed for LAN bridging functionality: MACRelayUnit deals with EtherFrames.

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleDataFrame().

{
    if (!isConnectedToHL) {
        delete frame;
        return;
    }
    cPacket *outFrame = nullptr;
    switch (encapDecap) {
        case ENCAP_DECAP_ETH:
#ifdef WITH_ETHERNET
            outFrame = convertToEtherFrame(frame);
#else // ifdef WITH_ETHERNET
            throw cRuntimeError("INET compiled without ETHERNET feature, but the 'encapDecap' parameter is set to 'eth'!");
#endif // ifdef WITH_ETHERNET
            break;

        case ENCAP_DECAP_TRUE: {
            cPacket *payload = frame->decapsulate();
            Ieee802Ctrl *ctrl = new Ieee802Ctrl();
            ctrl->setSrc(frame->getTransmitterAddress());
            ctrl->setDest(frame->getAddress3());
            int tid = frame->getTid();
            if (tid < 8)
                ctrl->setUserPriority(tid); // TID values 0..7 are UP
            Ieee80211DataFrameWithSNAP *frameWithSNAP = dynamic_cast<Ieee80211DataFrameWithSNAP *>(frame);
            if (frameWithSNAP)
                ctrl->setEtherType(frameWithSNAP->getEtherType());
            payload->setControlInfo(ctrl);
            delete frame;
            outFrame = payload;
        }
        break;

        case ENCAP_DECAP_FALSE:
            outFrame = frame;
            break;

        default:
            throw cRuntimeError("Unknown encapDecap value: %d", encapDecap);
            break;
    }
    send(outFrame, "upperLayerOut");
}

Member Data Documentation

EncapDecap inet::ieee80211::Ieee80211MgmtAPBase::encapDecap

protected

Referenced by encapsulate(), initialize(), and sendToUpperLayer().

bool inet::ieee80211::Ieee80211MgmtAPBase::isConnectedToHL

protected

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleDataFrame(), initialize(), and sendToUpperLayer().

---

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

• Ieee80211MgmtAPBase.h
• Ieee80211MgmtAPBase.cc