X2AppServer¶

simple module X2AppServer

Extends the INET’s SctpServer application by adding an input gate to receive messages from the X2 Manager module. The X2AppServer module is responsible for handling messages from the X2 Manager and forwarding them to the peer’s client X2App via the SCTP layer. It ensures that the messages are properly encapsulated in SCTP packets before being sent.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
LteX2App	compound module	Represents the container for all X2 applications that an e/gNodeB instantiates to enable X2 communications with its peer e/gNodeBs. Specifically, for each peer, this module contains two submodules:

Extends¶

Name	Type	Description
SctpServer ↗	simple module	Server app for SCTP-based request-reply protocols. Handles a single session (and SCTP connection) at a time.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
localAddress	string	“”	Comma-separated list of addresses
localPort	int	0	Port number to listen on
echo	bool	false	Echoes received packages when true
echoDelay	double	0s
delayFirstRead	double	0s
readingInterval	double	0s
messagesToPush	int	0
numPacketsToSendPerClient	int	0	Number of requests sent per session
numPacketsToReceivePerClient	int	1
requestLength	int	1452	Length of a request (bytes)
thinkTime	double	0s	Time gap between requests
waitToClose	double	0s	Time to wait between last message sent and abort
finishEndsSimulation	bool	false
ordered	bool	true
inboundStreams	int	17
outboundStreams	int	1
queueSize	int	0
prMethod	int	0	0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
prValue	double	0	For PR-SCTP
streamReset	bool	false
streamRequestTime	double	0s
streamToReset	int	0
streamPriorities	string	“”
binderModule	string	“binder”

Properties¶

Name	Value	Description
class	X2AppServer

Gates¶

Name	Direction	Size	Description
socketIn	input
socketOut	output
x2ManagerIn	input

Source code¶

//
// Extends the INET's SctpServer application by adding
// an input gate to receive messages from the X2 Manager module.
// The X2AppServer module is responsible for handling messages
// from the X2 Manager and forwarding them to the peer's client X2App via
// the SCTP layer. It ensures that the messages are properly encapsulated
// in SCTP packets before being sent.
//
simple X2AppServer extends SctpServer
{
    parameters:
        @class("X2AppServer");
        string binderModule = default("binder");

    gates:
        input x2ManagerIn @labels(X2Msg);
}

File: src/simu5g/x2/X2AppServer.ned