IX2User

module interface

Interface for modules that need to interact with the LteX2Manager to utilize X2 communication to perform tasks such as handover, dual connectivity, and Coordinated Multi-Point.

Inheritance diagram

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

Implemented by

Name	Type	Description
DcX2Forwarder	simple module	Performs bridging of data-plane packets between PDCP entities of two eNodeBs or gNodeBs when Dual Connectivity is employed. The module directly interfaces with the LteX2Manager to transfer such packets over the X2 interface.
HandoverX2Forwarder	simple module	Forwards the downlink a handover source holds for a UE leg to the target base station over X2-U, and delivers what arrives from a source to this node's HandoverPacketHolderEnb: the data forwarding of the handover, between the source's and the target's packet holders, through the LteX2Manager. The handover's signaling is the base stations' control plane's (ConnectionControlEnb).
LteCompManagerBase	simple module	Serves as the base class for Coordinated Multi-Point (CoMP) manager modules in LTE networks. It provides essential functionalities and parameters needed to manage CoMP operations. To implement a specific CoMP algorithm, extend this class and override its pure virtual methods.
LteCompManagerProportional	simple module	Implements a CoMP (Coordinated Multi-Point) Proportional Scheduling algorithm. It allows for coordinated scheduling among multiple eNodeBs by calculating the required Resource Block (RB) allocation proportionally based on user load. In this structure, the module can function as either a master or a slave node. Slave nodes send their RB requests to the master node, which then processes these requests by partitioning the available bandwidth and subsequently informs each slave node about the available RBs for transmission.

Known subclasses

Name	Type	Description
IDcX2Forwarder	module interface	Interface for the DC X2 Forwarder. This module extends the IX2User module interface to define the basic contract that any DC X2 Forwarder must adhere to.
IHandoverX2Forwarder	module interface	Interface for the Handover X2 Forwarder. This module extends the IX2User module interface to define the basic contract that any Handover X2 Forwarder must adhere to.
ILteCompManager	module interface	The LteCompManager interface defines the structure for the CoMP Manager. It extends the X2User interface and provides the necessary parameters and configurations for managing Coordinated Multi-Point (CoMP) communications in LTE networks.

Properties

Name	Value	Description
display	i=block/cogwheel

Source code

//
// Interface for modules that need to interact with the ~LteX2Manager to utilize
// X2 communication to perform tasks such as handover, dual connectivity, and
// Coordinated Multi-Point.
//
moduleinterface IX2User
{
    parameters:
        @display("i=block/cogwheel");
    gates:
        //# Connections to the X2 Manager
        input x2ManagerIn;
        output x2ManagerOut;
}

File: src/simu5g/x2/IX2User.ned