UnstructuredSinkApp¶

compound module UnstructuredSinkApp

Inheritance diagram¶

Extends¶

Name	Type	Description
UnstructuredApp	compound module	An application of a UE whose session is of type Unstructured (the UE’s sessionType parameter, see LteUe): it sends and receives opaque payload through the UE’s cellular NIC, which carries it over the session to the data network (see UserPlaneNodeControl for the N6 end of the session). The traffic source and sink are built from queueing model elements, as INET’s EthernetApp’s; UnstructuredIo attaches them to the NIC. UnstructuredSourceApp and UnstructuredSinkApp only send and only receive. A UE has at most one such application, in its unstructuredApp submodule vector.

Parameters¶

Name	Type	Default value	Description
interfaceTableModule	string		Relative module path of the interface table

Properties¶

Name	Value	Description
application
display	i=block/app

Gates¶

Name	Direction	Size	Description
socketIn	input
socketOut	output

Unassigned submodule parameters¶

Name	Type	Default value	Description
source ↗.displayStringTextFormat	string	“created %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source ↗.packetNameFormat	string	“%a-%c”	See directives in module documentation
source ↗.packetRepresentation	string	“byteCount”	Determines the chunk of the packet data
source ↗.packetProtocol	string	“unknown”
source ↗.packetLength	int
source ↗.packetData	int	-1
source ↗.attachCreationTimeTag	bool	true
source ↗.attachIdentityTag	bool	true
source ↗.attachDirectionTag	bool	true
source ↗.clockModule	string	“”	Relative path of a module that implements IClock; optional
source ↗.initialProductionOffset	double	-1s	Initial duration before which packets are not produced. When negative, then produce packet in initialize()
source ↗.productionInterval	double		Elapsed time between subsequent packets pushed to the connected packet consumer
source ↗.scheduleForAbsoluteTime	bool	true	When a clock is used, “relative” means that setting the clock will not affect the simulation time of the event
sink ↗.displayStringTextFormat	string	“received %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
sink ↗.clockModule	string	“”	Relative path of a module that implements IClock; optional
sink ↗.initialConsumptionOffset	double	0s	Initial duration before which packets are not consumed
sink ↗.consumptionInterval	double	0s	Elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time
sink ↗.scheduleForAbsoluteTime	bool	true	When a clock is used, “relative” means that setting the clock will not affect the simulation time of the event
io.interfaceTableModule	string		Relative module path of the interface table
io.interface	string	“cellular”	The name of the cellular NIC’s interface

Source code¶

//
// An ~UnstructuredApp that only receives
//
module UnstructuredSinkApp extends UnstructuredApp
{
    parameters:
        source.typename = "";
}

File: src/simu5g/apps/unstructured/UnstructuredSinkApp.ned