Loading...
Searching...
No Matches
udp_sink.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2020 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_NETWORK_UDP_SINK_H
#define INCLUDED_NETWORK_UDP_SINK_H
#include <gnuradio/network/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace network {
/*!
* \brief This block provides a UDP Sink block that can send
* data over UDP streams to a specified host.
* \ingroup networking_tools
*
* \details
* This block provides a UDP sink that supports sending data over
* a UDP stream to external applications. A number of header formats
* are supported including None (raw stream), and other header formats
* that allow for sequence numbers to be tracked. This feature allows
* the recipient to be aware of any frames dropped in transit or by
* its receiving stack. The UDP packet size can also be adjusted
* to support jumbo frames. For most networks, 1472 is the correct
* UDP data packet size that optimizes network transmission. Adjusting
* this value without a full understanding of the network implications
* can create additional network fragmentation and inefficient packet
* usage so should be avoided. For networks and endpoints supporting
* jumbo frames of 9000, 8972 would be the appropriate size
* (9000 - 28 header bytes). If send NULL packet as EOF is set, when
* the flowgraph terminates, an empty UDP packet is sent. This can
* be used on the receiving side to be aware that no more data may
* be received from the sending application. When pairing with the
* GNU Radio UDP source block, this isn't necessary and the source
* block can simply be set to source zero's when an incoming network
* data stream is not present in order to continue returning data
* from the work function. This block also supports IPv4 and IPv6
* addresses and is automatically determined from the address
* provided.
*/
class NETWORK_API udp_sink : virtual public gr::sync_block
{
public:
typedef std::shared_ptr<udp_sink> sptr;
/*!
* Build a udp_sink block.
*/
static sptr make(size_t itemsize,
size_t veclen,
const std::string& host,
int port,
int header_type,
int payloadsize,
bool send_eof);
};
} // namespace network
} // namespace gr
#endif /* INCLUDED_NETWORK_UDP_SINK_H */
gr::network::udp_sink
This block provides a UDP Sink block that can send data over UDP streams to a specified host.
Definition udp_sink.h:50
gr::network::udp_sink::make
static sptr make(size_t itemsize, size_t veclen, const std::string &host, int port, int header_type, int payloadsize, bool send_eof)
gr::network::udp_sink::sptr
std::shared_ptr< udp_sink > sptr
Definition udp_sink.h:52
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
NETWORK_API
#define NETWORK_API
Definition gr-network/include/gnuradio/network/api.h:19
gr::network
Definition socket_pdu.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h