A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::EpcX2 Class Reference

#include <epc-x2.h>

+ Inheritance diagram for ns3::EpcX2:

Public Member Functions

 EpcX2 ()
 
virtual ~EpcX2 (void)
 
void AddX2Interface (uint16_t enb1CellId, Ipv4Address enb1X2Address, uint16_t enb2CellId, Ipv4Address enb2X2Address)
 
virtual void DoDispose (void)
 
EpcX2SapProviderGetEpcX2SapProvider ()
 
void RecvFromX2cSocket (Ptr< Socket > socket)
 
void RecvFromX2uSocket (Ptr< Socket > socket)
 
void SetEpcX2SapUser (EpcX2SapUser *s)
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Member Functions

virtual void DoSendHandoverPreparationFailure (EpcX2SapProvider::HandoverPreparationFailureParams params)
 
virtual void DoSendHandoverRequest (EpcX2SapProvider::HandoverRequestParams params)
 
virtual void DoSendHandoverRequestAck (EpcX2SapProvider::HandoverRequestAckParams params)
 
virtual void DoSendLoadInformation (EpcX2SapProvider::LoadInformationParams params)
 
virtual void DoSendResourceStatusUpdate (EpcX2SapProvider::ResourceStatusUpdateParams params)
 
virtual void DoSendSnStatusTransfer (EpcX2SapProvider::SnStatusTransferParams params)
 
virtual void DoSendUeContextRelease (EpcX2SapProvider::UeContextReleaseParams params)
 
virtual void DoSendUeData (EpcX2SapProvider::UeDataParams params)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Protected Attributes

EpcX2SapProviderm_x2SapProvider
 
EpcX2SapUserm_x2SapUser
 

Private Attributes

uint16_t m_x2cUdpPort
 
std::map< Ptr< Socket >, Ptr
< X2CellInfo > > 
m_x2InterfaceCellIds
 
std::map< uint16_t, Ptr
< X2IfaceInfo > > 
m_x2InterfaceSockets
 
uint16_t m_x2uUdpPort
 

Friends

class EpcX2SpecificEpcX2SapProvider< EpcX2 >
 

Detailed Description

This entity is installed inside an eNB and provides the functionality for the X2 interface

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 70 of file epc-x2.h.

Constructor & Destructor Documentation

ns3::EpcX2::EpcX2 ( )

Constructor

Definition at line 85 of file epc-x2.cc.

References NS_LOG_FUNCTION.

ns3::EpcX2::~EpcX2 ( void  )
virtual

Destructor

Definition at line 94 of file epc-x2.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::EpcX2::AddX2Interface ( uint16_t  enb1CellId,
Ipv4Address  enb1X2Address,
uint16_t  enb2CellId,
Ipv4Address  enb2X2Address 
)
void ns3::EpcX2::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 100 of file epc-x2.cc.

References m_x2InterfaceCellIds, m_x2InterfaceSockets, and NS_LOG_FUNCTION.

EpcX2SapProvider * ns3::EpcX2::GetEpcX2SapProvider ( )
Parameters
sthe X2 SAP Provider interface offered by this EPC X2 entity

Definition at line 125 of file epc-x2.cc.

References NS_LOG_FUNCTION.

void ns3::EpcX2::RecvFromX2cSocket ( Ptr< Socket socket)

Method to be assigned to the recv callback of the X2-C (X2 Control Plane) socket. It is called when the eNB receives a packet from the peer eNB of the X2-C interface

Parameters
socketsocket of the X2-C interface

Definition at line 170 of file epc-x2.cc.

References ns3::Packet::GetSize(), m_x2InterfaceCellIds, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::Socket::Recv(), ns3::EpcX2SapUser::RecvHandoverRequest(), and ns3::Packet::RemoveHeader().

Referenced by AddX2Interface().

void ns3::EpcX2::RecvFromX2uSocket ( Ptr< Socket socket)

Method to be assigned to the recv callback of the X2-U (X2 User Plane) socket. It is called when the eNB receives a packet from the peer eNB of the X2-U interface

Parameters
socketsocket of the X2-U interface

Definition at line 370 of file epc-x2.cc.

References ns3::Packet::GetSize(), m_x2InterfaceCellIds, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Socket::Recv(), and ns3::Packet::RemoveHeader().

Referenced by AddX2Interface().

void ns3::EpcX2::SetEpcX2SapUser ( EpcX2SapUser s)
Parameters
sthe X2 SAP User to be used by this EPC X2 entity

Definition at line 118 of file epc-x2.cc.

References NS_LOG_FUNCTION.

Member Data Documentation

uint16_t ns3::EpcX2::m_x2cUdpPort
private

UDP ports to be used for the X2 interfaces: X2-C and X2-U

Definition at line 155 of file epc-x2.h.

Referenced by AddX2Interface().

std::map< Ptr<Socket>, Ptr<X2CellInfo> > ns3::EpcX2::m_x2InterfaceCellIds
private

Map the localSocket (the one receiving the X2 message) to the corresponding (sourceCellId, targetCellId) associated with the X2 interface

Definition at line 150 of file epc-x2.h.

Referenced by AddX2Interface(), DoDispose(), RecvFromX2cSocket(), and RecvFromX2uSocket().

std::map< uint16_t, Ptr<X2IfaceInfo> > ns3::EpcX2::m_x2InterfaceSockets
private

Map the targetCellId to the corresponding (sourceSocket, remoteIpAddr) to be used to send the X2 message

Definition at line 144 of file epc-x2.h.

Referenced by AddX2Interface(), and DoDispose().


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