Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.


// ip/udp.hpp
// ~~~~~~~~~~
// Copyright (c) 2003-2010 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at


#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include <boost/asio/detail/config.hpp>
#include <boost/asio/basic_datagram_socket.hpp>
#include <boost/asio/detail/socket_types.hpp>
#include <boost/asio/ip/basic_endpoint.hpp>
#include <boost/asio/ip/basic_resolver.hpp>
#include <boost/asio/ip/basic_resolver_iterator.hpp>
#include <boost/asio/ip/basic_resolver_query.hpp>

#include <boost/asio/detail/push_options.hpp>

namespace boost {
namespace asio {
namespace ip {

/// Encapsulates the flags needed for UDP.
 * The boost::asio::ip::udp class contains flags necessary for UDP sockets.
 * @par Thread Safety
 * @e Distinct @e objects: Safe.@n
 * @e Shared @e objects: Safe.
 * @par Concepts:
 * Protocol, InternetProtocol.
class udp
  /// The type of a UDP endpoint.
  typedef basic_endpoint<udp> endpoint;

  /// (Deprecated: use resolver::query.) The type of a resolver query.
  typedef basic_resolver_query<udp> resolver_query;

  /// (Deprecated: use resolver::iterator.) The type of a resolver iterator.
  typedef basic_resolver_iterator<udp> resolver_iterator;

  /// Construct to represent the IPv4 UDP protocol.
  static udp v4()
    return udp(PF_INET);

  /// Construct to represent the IPv6 UDP protocol.
  static udp v6()
    return udp(PF_INET6);

  /// Obtain an identifier for the type of the protocol.
  int type() const
    return SOCK_DGRAM;

  /// Obtain an identifier for the protocol.
  int protocol() const
    return IPPROTO_UDP;

  /// Obtain an identifier for the protocol family.
  int family() const
    return family_;

  /// The UDP socket type.
  typedef basic_datagram_socket<udp> socket;

  /// The UDP resolver type.
  typedef basic_resolver<udp> resolver;

  /// Compare two protocols for equality.
  friend bool operator==(const udp& p1, const udp& p2)
    return p1.family_ == p2.family_;

  /// Compare two protocols for inequality.
  friend bool operator!=(const udp& p1, const udp& p2)
    return p1.family_ != p2.family_;

  // Construct with a specific family.
  explicit udp(int family)
    : family_(family)

  int family_;

} // namespace ip
} // namespace asio
} // namespace boost

#include <boost/asio/detail/pop_options.hpp>