inet::ieee80211::Ieee80211MgmtBase Class Reference

Abstract base class for 802.11 infrastructure mode management components. More...

#include <Ieee80211MgmtBase.h>

Inheritance diagram for inet::ieee80211::Ieee80211MgmtBase:

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int) override
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...
Processing of different frame types
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

Protected Attributes
MACAddress	myAddress
bool	isOperational
long	numDataFramesReceived
long	numMgmtFramesReceived
long	numMgmtFramesDropped
virtual void	start ()
	lifecycle support More...
virtual void	stop ()
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...

Additional Inherited Members
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Detailed Description

Abstract base class for 802.11 infrastructure mode management components.

Author

Andras Varga

Member Function Documentation

void inet::ieee80211::Ieee80211MgmtBase::dropManagementFrame ( Ieee80211ManagementFrame *  frame )

protectedvirtual

Utility method to dispose of an unhandled frame.

Referenced by inet::ieee80211::Ieee80211MgmtAPSimplified::handleAssociationRequestFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleAssociationRequestFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleAssociationRequestFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleAssociationResponseFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleAssociationResponseFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleAssociationResponseFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleAuthenticationFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleAuthenticationFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleAuthenticationFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleBeaconFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleBeaconFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleBeaconFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleDeauthenticationFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleDeauthenticationFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleDeauthenticationFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleDisassociationFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleDisassociationFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleDisassociationFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleProbeRequestFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleProbeRequestFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleProbeRequestFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleProbeResponseFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleProbeResponseFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleProbeResponseFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleReassociationRequestFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleReassociationRequestFrame(), inet::ieee80211::Ieee80211MgmtSTASimplified::handleReassociationRequestFrame(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleReassociationResponseFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleReassociationResponseFrame(), and inet::ieee80211::Ieee80211MgmtSTASimplified::handleReassociationResponseFrame().

{
    EV << "ignoring management frame: " << (cMessage *)frame << "\n";
    delete frame;
    numMgmtFramesDropped++;
}

virtual void inet::ieee80211::Ieee80211MgmtBase::handleAssociationRequestFrame ( Ieee80211AssociationRequestFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleAssociationResponseFrame ( Ieee80211AssociationResponseFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleAuthenticationFrame ( Ieee80211AuthenticationFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleBeaconFrame ( Ieee80211BeaconFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleCommand ( int  msgkind, cObject *  ctrl  )

protectedpure virtual

Should be redefined to handle commands from the "agent" (if present)

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAPSimplified, and inet::ieee80211::Ieee80211MgmtAdhoc.

Referenced by handleMessage().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleDataFrame ( Ieee80211DataFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleDeauthenticationFrame ( Ieee80211DeauthenticationFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleDisassociationFrame ( Ieee80211DisassociationFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

void inet::ieee80211::Ieee80211MgmtBase::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

Dispatches incoming messages to handleTimer(), handleUpperMessage() or processFrame().

{
    if (!isOperational)
        throw cRuntimeError("Message '%s' received when module is OFF", msg->getName());

    if (msg->isSelfMessage()) {
        // process timers
        EV << "Timer expired: " << msg << "\n";
        handleTimer(msg);
    }
    else if (msg->arrivedOn("macIn")) {
        // process incoming frame
        EV << "Frame arrived from MAC: " << msg << "\n";
        Ieee80211DataOrMgmtFrame *frame = check_and_cast<Ieee80211DataOrMgmtFrame *>(msg);
        processFrame(frame);
    }
    else if (msg->arrivedOn("agentIn")) {
        // process command from agent
        EV << "Command arrived from agent: " << msg << "\n";
        int msgkind = msg->getKind();
        cObject *ctrl = msg->removeControlInfo();
        delete msg;

        handleCommand(msgkind, ctrl);
    }
    else {
        // packet from upper layers, to be sent out
        cPacket *pk = PK(msg);
        EV << "Packet arrived from upper layers: " << pk << "\n";
        handleUpperMessage(pk);
    }
}

bool inet::ieee80211::Ieee80211MgmtBase::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

overridevirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

{
    Enter_Method_Silent();
    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_PHYSICAL_LAYER)
            start();
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_PHYSICAL_LAYER)
            stop();
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH) // crash is immediate
            stop();
    }
    else
        throw cRuntimeError("Unsupported operation '%s'", operation->getClassName());
    return true;
}

virtual void inet::ieee80211::Ieee80211MgmtBase::handleProbeRequestFrame ( Ieee80211ProbeRequestFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleProbeResponseFrame ( Ieee80211ProbeResponseFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleReassociationRequestFrame ( Ieee80211ReassociationRequestFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleReassociationResponseFrame ( Ieee80211ReassociationResponseFrame *  frame )

protectedpure virtual

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAdhoc, and inet::ieee80211::Ieee80211MgmtAPSimplified.

Referenced by processFrame().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleTimer ( cMessage *  frame )

protectedpure virtual

Should be redefined to deal with self-messages.

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAPSimplified, and inet::ieee80211::Ieee80211MgmtAdhoc.

Referenced by handleMessage().

virtual void inet::ieee80211::Ieee80211MgmtBase::handleUpperMessage ( cPacket *  msg )

protectedpure virtual

Should be redefined to encapsulate and enqueue msgs from higher layers.

Implemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAPSimplified, and inet::ieee80211::Ieee80211MgmtAdhoc.

Referenced by handleMessage().

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

overrideprotectedvirtual

Reimplemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtAPBase, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAPSimplified, and inet::ieee80211::Ieee80211MgmtAdhoc.

Referenced by inet::ieee80211::Ieee80211MgmtAdhoc::initialize(), inet::ieee80211::Ieee80211MgmtSTASimplified::initialize(), inet::ieee80211::Ieee80211MgmtAPBase::initialize(), and inet::ieee80211::Ieee80211MgmtSTA::initialize().

{
    if (stage == INITSTAGE_LOCAL) {
        numDataFramesReceived = 0;
        numMgmtFramesReceived = 0;
        numMgmtFramesDropped = 0;
        WATCH(numDataFramesReceived);
        WATCH(numMgmtFramesReceived);
        WATCH(numMgmtFramesDropped);
    }
    else if (stage == INITSTAGE_LINK_LAYER) {
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
    }
    else if (stage == INITSTAGE_LINK_LAYER_2) {
        // obtain our address from MAC
        cModule *mac = getModuleFromPar<cModule>(par("macModule"), this);
        myAddress.setAddress(mac->par("address").stringValue());
    }
}

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

inlineoverrideprotectedvirtual

Reimplemented in inet::ieee80211::Ieee80211MgmtSTA, inet::ieee80211::Ieee80211MgmtAP, inet::ieee80211::Ieee80211MgmtAPBase, inet::ieee80211::Ieee80211MgmtSTASimplified, inet::ieee80211::Ieee80211MgmtAPSimplified, and inet::ieee80211::Ieee80211MgmtAdhoc.

{ return NUM_INIT_STAGES; }

void inet::ieee80211::Ieee80211MgmtBase::processFrame ( Ieee80211DataOrMgmtFrame *  frame )

protectedvirtual

Dispatch to frame processing methods according to frame type.

Referenced by handleMessage().

{
    switch (frame->getType()) {
        case ST_DATA:
        case ST_DATA_WITH_QOS:
            numDataFramesReceived++;
            handleDataFrame(check_and_cast<Ieee80211DataFrame *>(frame));
            break;

        case ST_AUTHENTICATION:
            numMgmtFramesReceived++;
            handleAuthenticationFrame(check_and_cast<Ieee80211AuthenticationFrame *>(frame));
            break;

        case ST_DEAUTHENTICATION:
            numMgmtFramesReceived++;
            handleDeauthenticationFrame(check_and_cast<Ieee80211DeauthenticationFrame *>(frame));
            break;

        case ST_ASSOCIATIONREQUEST:
            numMgmtFramesReceived++;
            handleAssociationRequestFrame(check_and_cast<Ieee80211AssociationRequestFrame *>(frame));
            break;

        case ST_ASSOCIATIONRESPONSE:
            numMgmtFramesReceived++;
            handleAssociationResponseFrame(check_and_cast<Ieee80211AssociationResponseFrame *>(frame));
            break;

        case ST_REASSOCIATIONREQUEST:
            numMgmtFramesReceived++;
            handleReassociationRequestFrame(check_and_cast<Ieee80211ReassociationRequestFrame *>(frame));
            break;

        case ST_REASSOCIATIONRESPONSE:
            numMgmtFramesReceived++;
            handleReassociationResponseFrame(check_and_cast<Ieee80211ReassociationResponseFrame *>(frame));
            break;

        case ST_DISASSOCIATION:
            numMgmtFramesReceived++;
            handleDisassociationFrame(check_and_cast<Ieee80211DisassociationFrame *>(frame));
            break;

        case ST_BEACON:
            numMgmtFramesReceived++;
            handleBeaconFrame(check_and_cast<Ieee80211BeaconFrame *>(frame));
            break;

        case ST_PROBEREQUEST:
            numMgmtFramesReceived++;
            handleProbeRequestFrame(check_and_cast<Ieee80211ProbeRequestFrame *>(frame));
            break;

        case ST_PROBERESPONSE:
            numMgmtFramesReceived++;
            handleProbeResponseFrame(check_and_cast<Ieee80211ProbeResponseFrame *>(frame));
            break;

        default:
            throw cRuntimeError("Unexpected frame type (%s)%s", frame->getClassName(), frame->getName());
    }
}

void inet::ieee80211::Ieee80211MgmtBase::sendDown ( cPacket *  frame )

protectedvirtual

Utility method for implementing handleUpperMessage(): send message to MAC.

Referenced by inet::ieee80211::Ieee80211MgmtAPBase::distributeReceivedDataFrame(), inet::ieee80211::Ieee80211MgmtAdhoc::handleUpperMessage(), inet::ieee80211::Ieee80211MgmtAPSimplified::handleUpperMessage(), and inet::ieee80211::Ieee80211MgmtSTASimplified::handleUpperMessage().

{
    ASSERT(isOperational);
    send(frame, "macOut");
}

void inet::ieee80211::Ieee80211MgmtBase::sendUp ( cMessage *  msg )

protectedvirtual

Utility method: sends the packet to the upper layer.

Referenced by inet::ieee80211::Ieee80211MgmtAdhoc::handleDataFrame(), and inet::ieee80211::Ieee80211MgmtSTASimplified::handleDataFrame().

{
    ASSERT(isOperational);
    send(msg, "upperLayerOut");
}

void inet::ieee80211::Ieee80211MgmtBase::start ( )

protectedvirtual

lifecycle support

Reimplemented in inet::ieee80211::Ieee80211MgmtAP.

Referenced by handleOperationStage(), and inet::ieee80211::Ieee80211MgmtAP::start().

{
    isOperational = true;
}

void inet::ieee80211::Ieee80211MgmtBase::stop ( )

protectedvirtual

Reimplemented in inet::ieee80211::Ieee80211MgmtAP.

Referenced by handleOperationStage(), and inet::ieee80211::Ieee80211MgmtAP::stop().

{
    isOperational = false;
}

Member Data Documentation

bool inet::ieee80211::Ieee80211MgmtBase::isOperational

protected

Referenced by handleMessage(), initialize(), sendDown(), sendUp(), start(), and stop().

MACAddress inet::ieee80211::Ieee80211MgmtBase::myAddress

protected

Referenced by initialize().

long inet::ieee80211::Ieee80211MgmtBase::numDataFramesReceived

protected

Referenced by initialize(), and processFrame().

long inet::ieee80211::Ieee80211MgmtBase::numMgmtFramesDropped

protected

Referenced by dropManagementFrame(), and initialize().

long inet::ieee80211::Ieee80211MgmtBase::numMgmtFramesReceived

protected

Referenced by initialize(), and processFrame().

---

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

• Ieee80211MgmtBase.h
• Ieee80211MgmtBase.cc