UDP/TCP Receiver/Sender From/To Non-ADTF Application Plugin

Table of Contents

• UDP Receiver From Non-ADTF Application
• UDP Sender To Non-ADTF Application
• TCP Receiver From Non-ADTF Application
• TCP Sender To Non-ADTF Application

UDP Receiver From Non-ADTF Application

Plugin Information

Plugin Filename	foreign_application_udp.adtfplugin
Plugin Description	foreign_application_udp.plugindescription
Plugin Name	Non ADTF UDP Receiver And Sender Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.18.2
Plugin File Version	1.0
adtf	3.18.2
adtf::ucom	3.1.0

Component Information

Name	UDP Receiver From Non ADTF Application
CID	demo_foreign_application_udp_receiver.streaming_source.adtf.cid
Description	Use this Streaming Source to receive sample data from a Non-ADTF Application using the UDP protocol
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
ddl_struct_name		cString	If set, the stream type will contain the media description of the given struct, retrieved from the Media Description Service.
deserialize_via_media_description	false	tBool	If activated, incoming data will be deserialized as defined by the media description of the struct selected via ddl_struct_name before writing it into output samples.
interface		cString	if set, bind the socket to this local interface
mark_samples_as_deserialized	true	tBool	In case that 'deserialize_via_media_description' is disabled, this will force the output stream type to have the deserialized flag set.
multicast_group		cString	if set, join the given multicast group
port	0	tUInt16	The UDP port to bind to and listen on.
receive_buffer_size	9000	tUInt64	Maximum payload size in bytes this filter can accept. Choose according to configured MTU. Values up to 64kB are plausible from UDP side.	Value Range: minimum = 1 maximum = 65535
socket_receive_buffer_size	0	tUInt64	Sockets receive buffer size in bytes (min: 4098, Default: 0 - uses system default)

Output Pins

Name	Stream Type	Description
output	non_adtf_udp_receiver_and_sender_plugin_demo_foreign_application_udp_receiver_streaming_source_adtf_cid_output	Provides the sample data received from a Non-ADTF instance over UDP

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
socket_thread	6	0		1	1	0	0	Connect a Thread Runner that will provide the context for receiving all data from the socket. If this is not connected, the source will create a thread on its own.

Input Binding Objects

Name	IID	Proxy OID	Description
socket	udp_socket.demo.adtf		Interface server to provide a shared socket for communication

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Required Interfaces

IID
reference_clock.riddler.streaming.adtf.iid
kernel.penguin.services.adtf.iid

Output Pin Stream Types

Pin Name	output
Meta Type Name
Stream Type Properties

UDP Sender To Non-ADTF Application

Plugin Information

Plugin Filename	foreign_application_udp.adtfplugin
Plugin Description	foreign_application_udp.plugindescription
Plugin Name	Non ADTF UDP Receiver And Sender Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.18.2
Plugin File Version	1.0
adtf	3.18.2
adtf::ucom	3.1.0

Component Information

Name	UDP Sender To Non ADTF Application
CID	demo_foreign_application_udp_sender.streaming_sink.adtf.cid
Description	Use this Streaming Sink to transmit sample data to a Non-ADTF Application using the UDP protocol
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
port	0	tUInt16	This is only taken into account when remote_host is set as well and when this sink is not connected to a source via the socket interface binding.
remote_host		cString	If set, send data to this host. This is required if the sink is not connected to a source. If this property is empty, packets will be sent to the last endpoint that data was received from. If set to 'localhost' the IPv4 localhost address '127.0.0.1' is used. IPv4 Example: '127.0.0.1' IPv6 Example: '::1'
serialize_via_media_description	false	tBool	If activated, incoming samples will be serialized as defined by the media description of the stream type before sending it via the socket.

Input Pins

Name	Stream Type	Description
input	adtf/anonymous	Incoming data to transmit

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
process_input	9	1	input	0	0	0	0	Default runner port for the input pin 'input'

Output Binding Objects

Name	IID	Proxy OID	Description
socket	udp_socket.demo.adtf		Interface client to use a shared socket for communication. The connected socket provides the local host and port to bound as source.

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Input Pin Stream Types

Pin Name	input
Meta Type Name	adtf/anonymous
Stream Type Properties

TCP Receiver From Non-ADTF Application

Plugin Information

Plugin Filename	foreign_application_tcp.adtfplugin
Plugin Description	foreign_application_tcp.plugindescription
Plugin Name	Non ADTF TCP Receiver And Sender Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.18.2
Plugin File Version	1.0
adtf	3.18.2
adtf::ucom	3.1.0

Component Information

Name	TCP Receiver From Non ADTF Application
CID	demo_foreign_application_tcp_receiver.streaming_source.adtf.cid
Description	Use this Streaming Source to receive sample data from a Non-ADTF Application using the TCP protocol
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
ddl_struct_name		cString	If set, the stream type will contain the media description of the given struct, retrieved from the Media Description Service.
deserialize_via_media_description	false	tBool	If activated, incoming data will be deserialized as defined by the media description of the struct selected via ddl_struct_name before writing it into output samples.
enable_automatic_reconnection	false	tBool	If enabled, connection loss is not treated as an error, but the source tries to reconnect.
fixed_packet_size	0	tUInt64	If non-zero, the source will wait to read this amount of bytes before putting them into a Sample.
mark_samples_as_deserialized	true	tBool	In case that 'deserialize_via_media_description' is disabled, this will force the output stream type to have the deserialized flag set.
remote_host		cString	The hostname or ip address that the source should connect to.
remote_port	0	tUInt16	The port on the remote host that the source should connect to.

Output Pins

Name	Stream Type	Description
output	non_adtf_tcp_receiver_and_sender_plugin_demo_foreign_application_tcp_receiver_streaming_source_adtf_cid_output	Provides the sample data received from a Non-ADTF instance over TCP

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
receive_data	6	0		1	1	0	0	Connect a Thread Runner that will provide the context for receiving all data. If this is not connected, the source will create a thread on its own.

Input Binding Objects

Name	IID	Proxy OID	Description
socket	tcp_socket.demo.adtf		Interface server to provide a shared socket for communication

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Required Interfaces

IID
reference_clock.riddler.streaming.adtf.iid
kernel.penguin.services.adtf.iid

Output Pin Stream Types

Pin Name	output
Meta Type Name
Stream Type Properties

TCP Sender To Non-ADTF Application

Plugin Information

Plugin Filename	foreign_application_tcp.adtfplugin
Plugin Description	foreign_application_tcp.plugindescription
Plugin Name	Non ADTF TCP Receiver And Sender Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.18.2
Plugin File Version	1.0
adtf	3.18.2
adtf::ucom	3.1.0

Component Information

Name	TCP Sender To Non ADTF Application
CID	demo_foreign_application_tcp_sender.streaming_sink.adtf.cid
Description	Use this Streaming Sink to transmit sample data to a Non-ADTF Application using the TCP protocol
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
enable_automatic_reconnection	false	tBool	If enabled, connection loss is not treated as an error, but the source tries to reconnect. This is only taken into account when the sink is not connected to a source via the socket interface binding.
no_tcp_delay	true	tBool	If activated, the TCP_NODELAY option will be set for the socket.
remote_host		cString	This is only taken into account when the sink is not connected to a source via the socket interface binding. If set to 'localhost' the IPv4 localhost address '127.0.0.1' is used. IPv4 Example: '127.0.0.1' IPv6 Example: '::1'
remote_port	0	tUInt16	This is only taken into account when the sink is not connected to a source via the socket interface binding.
serialize_via_media_description	false	tBool	If activated, incoming samples will be serialized as defined by the media description of the stream type before sending it via the socket.

Input Pins

Name	Stream Type	Description
input	adtf/anonymous	Incoming data to transmit

Runner

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
process_input	9	1	input	0	0	0	0	Default runner port for the input pin 'input'

Output Binding Objects

Name	IID	Proxy OID	Description
socket	tcp_socket.demo.adtf		Interface client to use a shared socket for communication

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Input Pin Stream Types

Pin Name	input
Meta Type Name	adtf/anonymous
Stream Type Properties

Source Code

• Source Code for UDP/TCP Receiver/Sender From/To Non-ADTF Application Plugin

Test

• Test for Non-ADTF Sinks and Sources Plugin

Common Remarks

• Sources and Sinks will share a single socket if they are connected to each other via the "socket" interface binding.
• The "ddl_struct_name" Property allows you to specify the name of a struct media description that is provided via the Media Description Service. This type will be used to create a Stream Type for the output Pin.
• If you activate the "deserialize_via_media_description" and/or "serialize_via_media_description" properties, incoming/outgoing data will be deserialized/serialized as defined by the media description of the selected struct or the Stream Type.
• The small demo application will return any received UDP packets or TCP data back to the sender.

Properties

• The Source creates a UDP / TCP socket and forwards all received UDP / TCP packets as ADTF samples.
• Use the "remote_host" and "remote_port" properties to bind to a specific local interface and port.
• The Sink forwards data from samples received via its input pin as UDP / TCP packets.
• Use the "remote_host" and "remote_port" Properties to specify the destination. If you leave this empty and the Sink shares a socket with a Source, then packets will be sent to the address/port that the last packet was received from. This works only of the Sink is connected to a Source via interface binding.

Usage of demo_non_adtf_application executable

• With -p you can specify a communication port, e.g. demo_non_adtf_application -p 12345
• With -tcp you can create a TCP server, e.g. demo_non_adtf_application -tcp
• With -ipv6 you can enable IPv6 support, e.g. demo_non_adtf_application -ipv6
• Without any arguments, the demo_non_adtf_application starts an UDP Server using IPv4 on port 54321

Note

Make sure to start the executable and creating the server before launching example session