Hcf

Package: inet.linklayer.ieee80211.mac.coordinationfunction

Hcf

compound module

HCF -- Hybrid Coordination Function

Edca Hcca OriginatorQosMacDataService RecipientQosMacDataService QosRateSelection IRateControl SingleProtectionMechanism NonQosRecoveryProcedure QosRecoveryProcedure TxopProcedure OriginatorQosAckPolicy RecipientQosAckPolicy QosRtsPolicy QosCtsPolicy OriginatorBlockAckAgreementPolicy RecipientBlockAckAgreementPolicy

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Parameters

Name Type Default value Description
numEdcafs int 4
maxQueueSize int 100 -1 means unlimited
isBlockAckSupported bool false
prioritizeMulticast bool false

if true, prioritize multicast frames (9.3.2.1 Fundamental access)

rxModule string
txModule string

Properties

Name Value Description
class Hcf
display i=block/queue

Signals

Name Type Unit
packetDropped inet::Packet
linkBroken inet::Packet

Unassigned submodule parameters

Name Type Default value Description
rateSelection.multicastFrameBitrate double -1bps
rateSelection.responseAckFrameBitrate double -1bps
rateSelection.responseBlockAckFrameBitrate double -1bps
rateSelection.responseCtsFrameBitrate double -1bps
rateSelection.dataFrameBitrate double -1bps

fastest

rateSelection.dataFrameBandwidth double nan Hz

unspecified by default

rateSelection.dataFrameNumSpatialStreams int -1

unspecified by default

rateSelection.mgmtFrameBitrate double -1bps

fastest

rateSelection.controlFrameBitrate double -1bps
singleProtectionMechanism.rateSelectionModule string
edcaMgmtAndNonQoSRecoveryProcedure.shortRetryLimit int 7
edcaMgmtAndNonQoSRecoveryProcedure.longRetryLimit int 4
edcaDataRecoveryProcedures.shortRetryLimit int 7
edcaDataRecoveryProcedures.longRetryLimit int 4
edcaTxopProcedures.txopLimit double -1s
originatorAckPolicy.rateSelectionModule string
originatorAckPolicy.blockAckReqTreshold int 5
originatorAckPolicy.maxBlockAckPolicyFrameLength int 1000B
originatorAckPolicy.blockAckTimeout double -1s
originatorAckPolicy.ackTimeout double -1s
recipientAckPolicy.rateSelectionModule string
rtsPolicy.rateSelectionModule string
rtsPolicy.ctsTimeout double -1s
rtsPolicy.rtsThreshold int 2346B
ctsPolicy.rxModule string
ctsPolicy.rateSelectionModule string
originatorBlockAckAgreementPolicy.delayedAckPolicySupported bool false
originatorBlockAckAgreementPolicy.aMsduSupported bool true
originatorBlockAckAgreementPolicy.maximumAllowedBufferSize int 64
originatorBlockAckAgreementPolicy.blockAckTimeoutValue double 0s

0 means that it depends on the originator

recipientBlockAckAgreementPolicy.delayedAckPolicySupported bool false
recipientBlockAckAgreementPolicy.aMsduSupported bool true
recipientBlockAckAgreementPolicy.maximumAllowedBufferSize int 64
recipientBlockAckAgreementPolicy.blockAckTimeoutValue double 0s

0 means that it depends on the originator

Source code

//
// HCF -- Hybrid Coordination Function
//
module Hcf like IHcf
{
    parameters:
        int numEdcafs = default(4);
        int maxQueueSize = default(100); // -1 means unlimited
        bool isBlockAckSupported = default(false);
        bool prioritizeMulticast = default(false); // if true, prioritize multicast frames (9.3.2.1 Fundamental access)

        string rxModule;
        string txModule;

        *.rateSelectionModule = "^.rateSelection";
        *.rxModule = "^." + rxModule;

        @class(Hcf);
        @display("i=block/queue");
        @signal[linkBroken](type=inet::Packet);
        @signal[packetDropped](type=inet::Packet);

    submodules:
        edca: Edca {
            parameters:
                numEdcafs = numEdcafs;
                @display("p=150,100");
        }
        hcca: Hcca {
            parameters:
                @display("p=150,200");
        }
        originatorMacDataService: OriginatorQosMacDataService {
            parameters:
                @display("p=150,300");
        }
        recipientMacDataService: RecipientQosMacDataService {
            parameters:
                @display("p=150,400");
        }
        rateSelection: QosRateSelection {
            parameters:
                rateControlModule = "^.rateControl";
                @display("p=350,100");
        }
        rateControl: <default("")> like IRateControl if typename != "" {
            parameters:
                @display("p=350,200");
        }
        singleProtectionMechanism: SingleProtectionMechanism {
            parameters:
                @display("p=350,300");
        }
        edcaMgmtAndNonQoSRecoveryProcedure: NonQosRecoveryProcedure {
            parameters:
                cwCalculatorModule = "^.edca.edcaf[1]"; // best effort
                rtsPolicyModule = "^.rtsPolicy";
                @display("p=550,300");
        }
        edcaDataRecoveryProcedures[numEdcafs]: QosRecoveryProcedure {
            parameters:
                cwCalculatorModule = "^.edca.edcaf[" + string(index) + "]";
                rtsPolicyModule = "^.rtsPolicy";
                @display("p=550,400,column,100");
        }
        edcaTxopProcedures[numEdcafs]: TxopProcedure {
            parameters:
                @display("p=350,400,column,100");
        }
        originatorAckPolicy: OriginatorQosAckPolicy {
            parameters:
                @display("p=750,100");
        }
        recipientAckPolicy: RecipientQosAckPolicy {
            parameters:
                @display("p=750,200");
        }
        rtsPolicy: QosRtsPolicy {
            parameters:
                @display("p=750,300");
        }
        ctsPolicy: QosCtsPolicy {
            parameters:
                @display("p=750,400");
        }
        originatorBlockAckAgreementPolicy: OriginatorBlockAckAgreementPolicy if isBlockAckSupported {
            parameters:
                originatorAckPolicyModule = "^.originatorAckPolicy";
                @display("p=750,500");
        }
        recipientBlockAckAgreementPolicy: RecipientBlockAckAgreementPolicy if isBlockAckSupported {
            parameters:
                @display("p=750,600");
        }
}

File: src/inet/linklayer/ieee80211/mac/coordinationfunction/Hcf.ned