xtd::net::sockets::udp_client Class Reference

Inheritance diagram for xtd::net::sockets::udp_client:

Definition

Provides User Datagram Protocol (UDP) network services.

class coore_export_ udp_client : public xtd::object

Inheritance

xtd::object → xtd::net::sockets::udp_client

Header

#include <xtd/net/sockets/udp_client>

Namespace

xtd::net::sockets

Library

xtd.core

Remarks

The xtd::net::sockets::udp_client class provides simple methods for sending and receiving connectionless UDP datagrams in blocking synchronous mode. Because UDP is a connectionless transport protocol, you do not need to establish a remote host connection prior to sending and receiving data. You do, however, have the option of establishing a default remote host in one of the following two ways:

• Create an instance of the xtd::net::sockets::udp_client class using the remote host name and port number as parameters.
• Create an instance of the xtd::net::sockets::udp_client class and then call the xtd::net::sockets::udp_client::connect method.

You can use any of the send methods provided in the xtd::net::sockets::udp_client to send data to a remote device. Use the xtd::net::sockets::udp_client::receive method to receive data from remote hosts.

Note

Do not call xtd::net::sockets::udp_client::send using a host name or xtd::net::ip_end_point if you have already specified a default remote host. If you do, xtd::net::sockets::udp_client will throw an exception.

Remarks

xtd::net::sockets::udp_client methods also allow you to send and receive multicast datagrams. Use the xtd::net::sockets::udp_client::join_multicast_group method to subscribe a xtd::net::sockets::udp_client to a multicast group. Use the xtd::net::sockets::udp_client::drop_multicast_group method to unsubscribe a xtd::net::sockets::udp_client from a multicast group.

Examples

The following example shows how to use IPv4 xtd::net::sockets::udp_client class.

#include <xtd/collections/generic/list>
#include <xtd/io/stream_reader>
#include <xtd/net/sockets/udp_client>
#include <xtd/net/ip_end_point>
#include <xtd/threading/thread>
#include <xtd/console>
 
using namespace xtd;
using namespace xtd::collections::generic;
using namespace xtd::net;
using namespace xtd::net::sockets;
using namespace xtd::threading;
 
auto main() -> int {
  auto terminate_app = false;
  
  auto server = thread {[&] {
    auto udp = udp_client {ip_end_point {ip_address::any, 9400}};
    while (!terminate_app) {
      ip_end_point incoming_end_point;
      auto buffer = udp.receive(incoming_end_point);
      if (buffer.size() && buffer[0] != 0xFF)
        console::write_line(string(buffer.begin(), buffer.end()));
    }
  }};
  
  auto client = thread {[&] {
    auto udp = udp_client {};
    auto counter = 0;
    while (!terminate_app) {
      auto str = string::format("counter={}", ++counter);
      udp.send(list<unsigned char>(str.begin(), str.end()), str.size(), ip_end_point(ip_address::loopback, 9400));
      thread::sleep(50_ms);
    }
    udp.send(list<unsigned char> {0xFF}, 1, ip_end_point(ip_address::loopback, 9400));
  }};
 
  server.start();
  client.start();
 
  console::read_key();
  terminate_app = true;
  server.join();
  client.join();
}
 
// This code produces the following output :
//
// counter=1
// counter=2
// counter=3
// counter=4
// counter=5
// ...

Examples

The following example shows how to use IPv6 xtd::net::sockets::udp_client class.

#include <xtd/collections/generic/list>
#include <xtd/io/stream_reader>
#include <xtd/net/sockets/udp_client>
#include <xtd/net/ip_end_point>
#include <xtd/threading/thread>
#include <xtd/console>
 
using namespace xtd;
using namespace xtd::collections::generic;
using namespace xtd::net;
using namespace xtd::net::sockets;
using namespace xtd::threading;
 
auto main() -> int {
  auto terminate_app = false;
  
  auto server = thread {[&] {
    auto udp = udp_client {ip_end_point {ip_address::ip_v6_any, 9400}};
    while (!terminate_app) {
      auto incoming_end_point = ip_end_point {};
      auto buffer = udp.receive(incoming_end_point);
      if (buffer.size() && buffer[0] != 0xFF)
        console::write_line(string(buffer.begin(), buffer.end()));
    }
  }};
  
  auto client = thread {[&] {
    auto udp = udp_client {address_family::inter_network_v6};
    auto counter = 0;
    while (!terminate_app) {
      auto str = string::format("counter={}", ++counter);
      udp.send(list<unsigned char>(str.begin(), str.end()), str.size(), ip_end_point(ip_address::ip_v6_loopback, 9400));
      thread::sleep(50_ms);
    }
    
    udp.send(list<unsigned char> {0xFF}, 1, ip_end_point(ip_address::ip_v6_loopback, 9400));
  }};
 
  server.start();
  client.start();
 
  console::read_key();
  terminate_app = true;
  server.join();
  client.join();
}
 
// This code produces the following output :
//
// counter=1
// counter=2
// counter=3
// counter=4
// counter=5
// ...

Examples

udp_client_ip_v4.cpp, and udp_client_ip_v6.cpp.

Public Constructors
	udp_client ()
	Initializes a new instance of the xtd::net::sockets::udp_client class.
	udp_client (uint16 port)
	Initializes a new instance of the xtd::net::sockets::udp_client class and binds it to the local port number provided.
	udp_client (const xtd::net::ip_end_point &local_end_point)
	Initializes a new instance of the xtd::net::sockets::udp_client class and binds it to the specified local endpoint.
	udp_client (xtd::net::sockets::address_family address_Family)
	Initializes a new instance of the xtd::net::sockets::udp_client class.
	udp_client (uint16 port, xtd::net::sockets::address_family addressFamily)
	Initializes a new instance of the xtd::net::sockets::udp_client class and binds it to the local port number provided.
	udp_client (const xtd::string &hostname, uint16 port)
	Initializes a new instance of the xtd::net::sockets::udp_client class and establishes a default remote host.

Public Properties
size_t	available () const
	Gets the amount of data received from the network that is available to read.
xtd::net::sockets::socket	client () const noexcept
	Gets the underlying network xtd::net::sockets::socket.
udp_client &	client (const xtd::net::sockets::socket &value) noexcept
	Sets the underlying network xtd::net::sockets::socket.
bool	dont_fragment () const
	Gets a boolean value that specifies whether the xtd::net::sockets::udp_client allows Internet Protocol (IP) datagrams to be fragmented.
udp_client &	dont_fragment (bool value)
	Sets boolean value that specifies whether the xtd::net::sockets::udp_client allows Internet Protocol (IP) datagrams to be fragmented.
bool	enable_broadcast () const
	Gets a boolean value that specifies whether the xtd::net::sockets::udp_client may send or receive broadcast packets.
udp_client &	enable_broadcast (bool value)
	Sets a boolean value that specifies whether the xtd::net::sockets::udp_client may send or receive broadcast packets.
bool	exclusive_address_use () const
	Gets a boolean value that specifies whether the xtd::net::sockets::udp_client allows only one client to use a port.
udp_client &	exclusive_address_use (bool value)
	Sets a boolean value that specifies whether the xtd::net::sockets::udp_client allows only one client to use a port.
bool	multicast_loopback () const
	Gets a boolean value that specifies whether outgoing multicast packets are delivered to the sending application.
udp_client &	multicast_loopback (bool value)
	Sets a boolean value that specifies whether outgoing multicast packets are delivered to the sending application.
xtd::byte	ttl () const
	Gets a value that specifies the Time to Live (TTL) value of Internet Protocol (IP) packets sent by the xtd::net::sockets::udp_client.
udp_client &	ttl (xtd::byte value)
	Sets a value that specifies the Time to Live (TTL) value of Internet Protocol (IP) packets sent by the xtd::net::sockets::udp_client.

Public Methods
void	allow_nat_traversal (bool allowed)
	Enables or disables Network Address Translation (NAT) traversal on a xtd::net::sockets::udp_client instance.
xtd::sptr< xtd::iasync_result >	begin_receive (xtd::async_callback callback, const std::any &state)
	xtd::net::sockets::udp_client::receives a datagram from a remote host asynchronously.
xtd::sptr< xtd::iasync_result >	begin_send (const std::vector< xtd::byte > &dgram, size_t bytes, const xtd::string &hostname, uint16 port, xtd::async_callback callback, const std::any &state)
	xtd::net::sockets::udp_client::sends a datagram to a destination asynchronously. The destination is specified by the host name and port number.
xtd::sptr< xtd::iasync_result >	begin_send (const std::vector< xtd::byte > &dgram, size_t bytes, const xtd::net::ip_end_point &end_point, xtd::async_callback callback, const std::any &state)
	xtd::net::sockets::udp_client::sends a datagram to a destination asynchronously. The destination is specified by a EndPoint.
xtd::sptr< xtd::iasync_result >	begin_send (const std::vector< xtd::byte > &dgram, size_t bytes, xtd::async_callback callback, const std::any &state)
	xtd::net::sockets::udp_client::sends a datagram to a remote host asynchronously. The destination was specified previously by a call to xtd::net::sockets::udp_client::connect.
void	close ()
	Closes the UDP connection.
void	connect (const xtd::net::ip_end_point &end_point)
	Establishes a default remote host using the specified network endpoint.
void	connect (const xtd::net::ip_address &ip_address, uint16 port)
	Establishes a default remote host using the specified IP address and port number.
void	connect (const xtd::string &hostname, uint16 port)
	Establishes a default remote host using the specified hostname and port number.
void	drop_multicast_group (const xtd::net::ip_address &multicast_address)
	Leaves a multicast group.
void	drop_multicast_group (const xtd::net::ip_address &multicast_address, uint32 if_index)
	Leaves a multicast group.
std::vector< xtd::byte >	end_receive (xtd::sptr< xtd::iasync_result > async_result, xtd::net::ip_end_point &remote_end_point)
	Ends a pending asynchronous receive.
size_t	end_send (xtd::sptr< xtd::iasync_result > async_result)
	Ends a pending asynchronous send.
bool	equals (const udp_client &s) const noexcept override
void	join_multicast_group (const xtd::net::ip_address &multicast_address)
	Adds a xtd::net::sockets::udp_client to a multicast group.
void	join_multicast_group (uint32 if_index, const xtd::net::ip_address &multicast_address)
	Adds a xtd::net::sockets::udp_client to a multicast group.
void	join_multicast_group (const xtd::net::ip_address &multicast_address, xtd::byte ttl)
	Adds a xtd::net::sockets::udp_client to a multicast group with the specified Time to Live (TTL).
void	join_multicast_group (const xtd::net::ip_address &multicast_address, const xtd::net::ip_address &local_address)
	Adds a xtd::net::sockets::udp_client to a multicast group.
std::vector< xtd::byte >	receive (xtd::net::ip_end_point &remote_end_point)
	Returns a UDP datagram that was sent by a remote host.
size_t	send (const std::vector< xtd::byte > &dgram, size_t bytes, const xtd::string &hostname, uint16 port)
	xtd::net::sockets::udp_client::sends a UDP datagram to a specified port on a specified remote host.
size_t	send (const std::vector< xtd::byte > &dgram, size_t bytes, const xtd::net::ip_end_point &end_point)
	xtd::net::sockets::udp_client::sends a UDP datagram to the host at the specified remote endpoint.
size_t	send (const std::vector< xtd::byte > &dgram, size_t bytes)
	xtd::net::sockets::udp_client::sends a UDP datagram to a remote host.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.

Protected Properties
bool	active () const noexcept
	Gets a value that indicates whether a connection has been made.
udp_client &	active (bool value) noexcept
	Sets a value that indicates whether a connection has been made.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Public Member Functions inherited from xtd::iequatable< udp_client >
virtual bool	equals (const udp_client &) const noexcept=0
	Indicates wheth er the current object is equal to another object of the same type.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

---

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

• xtd.core/include/xtd/net/sockets/udp_client.h