EIC code displayed by LXR master/​include/​boost/​asio/​local/​basic_endpoint.hpp	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 09:29:00

 //
 // local/basic_endpoint.hpp
 // ~~~~~~~~~~~~~~~~~~~~~~~~
 //
 // Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff dot com)
 // Derived from a public domain implementation written by Daniel Casimiro.
 //
 // Distributed under the Boost Software License, Version 1.0. (See accompanying
 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 //
 
 #ifndef BOOST_ASIO_LOCAL_BASIC_ENDPOINT_HPP
 #define BOOST_ASIO_LOCAL_BASIC_ENDPOINT_HPP
 
 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
 # pragma once
 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
 
 #include <boost/asio/detail/config.hpp>
 
 #if defined(BOOST_ASIO_HAS_LOCAL_SOCKETS) \
   || defined(GENERATING_DOCUMENTATION)
 
 #include <boost/asio/local/detail/endpoint.hpp>
 
 #if !defined(BOOST_ASIO_NO_IOSTREAM)
 # include <iosfwd>
 #endif // !defined(BOOST_ASIO_NO_IOSTREAM)
 
 #include <boost/asio/detail/push_options.hpp>
 
 namespace boost {
 namespace asio {
 namespace local {
 
 /// Describes an endpoint for a UNIX socket.
 /**
  * The boost::asio::local::basic_endpoint class template describes an endpoint
  * that may be associated with a particular UNIX socket.
  *
  * @par Thread Safety
  * @e Distinct @e objects: Safe.@n
  * @e Shared @e objects: Unsafe.
  *
  * @par Concepts:
  * Endpoint.
  */
 template <typename Protocol>
 class basic_endpoint
 {
 public:
   /// The protocol type associated with the endpoint.
   typedef Protocol protocol_type;
 
   /// The type of the endpoint structure. This type is dependent on the
   /// underlying implementation of the socket layer.
 #if defined(GENERATING_DOCUMENTATION)
   typedef implementation_defined data_type;
 #else
   typedef boost::asio::detail::socket_addr_type data_type;
 #endif
 
   /// Default constructor.
   basic_endpoint() noexcept
   {
   }
 
   /// Construct an endpoint using the specified path name.
   basic_endpoint(const char* path_name)
     : impl_(path_name)
   {
   }
 
   /// Construct an endpoint using the specified path name.
   basic_endpoint(const std::string& path_name)
     : impl_(path_name)
   {
   }
 
   #if defined(BOOST_ASIO_HAS_STRING_VIEW)
   /// Construct an endpoint using the specified path name.
   basic_endpoint(string_view path_name)
     : impl_(path_name)
   {
   }
   #endif // defined(BOOST_ASIO_HAS_STRING_VIEW)
 
   /// Copy constructor.
   basic_endpoint(const basic_endpoint& other)
     : impl_(other.impl_)
   {
   }
 
   /// Move constructor.
   basic_endpoint(basic_endpoint&& other)
     : impl_(other.impl_)
   {
   }
 
   /// Assign from another endpoint.
   basic_endpoint& operator=(const basic_endpoint& other)
   {
     impl_ = other.impl_;
     return *this;
   }
 
   /// Move-assign from another endpoint.
   basic_endpoint& operator=(basic_endpoint&& other)
   {
     impl_ = other.impl_;
     return *this;
   }
 
   /// The protocol associated with the endpoint.
   protocol_type protocol() const
   {
     return protocol_type();
   }
 
   /// Get the underlying endpoint in the native type.
   data_type* data()
   {
     return impl_.data();
   }
 
   /// Get the underlying endpoint in the native type.
   const data_type* data() const
   {
     return impl_.data();
   }
 
   /// Get the underlying size of the endpoint in the native type.
   std::size_t size() const
   {
     return impl_.size();
   }
 
   /// Set the underlying size of the endpoint in the native type.
   void resize(std::size_t new_size)
   {
     impl_.resize(new_size);
   }
 
   /// Get the capacity of the endpoint in the native type.
   std::size_t capacity() const
   {
     return impl_.capacity();
   }
 
   /// Get the path associated with the endpoint.
   std::string path() const
   {
     return impl_.path();
   }
 
   /// Set the path associated with the endpoint.
   void path(const char* p)
   {
     impl_.path(p);
   }
 
   /// Set the path associated with the endpoint.
   void path(const std::string& p)
   {
     impl_.path(p);
   }
 
   /// Compare two endpoints for equality.
   friend bool operator==(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return e1.impl_ == e2.impl_;
   }
 
   /// Compare two endpoints for inequality.
   friend bool operator!=(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return !(e1.impl_ == e2.impl_);
   }
 
   /// Compare endpoints for ordering.
   friend bool operator<(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return e1.impl_ < e2.impl_;
   }
 
   /// Compare endpoints for ordering.
   friend bool operator>(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return e2.impl_ < e1.impl_;
   }
 
   /// Compare endpoints for ordering.
   friend bool operator<=(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return !(e2 < e1);
   }
 
   /// Compare endpoints for ordering.
   friend bool operator>=(const basic_endpoint<Protocol>& e1,
       const basic_endpoint<Protocol>& e2)
   {
     return !(e1 < e2);
   }
 
 private:
   // The underlying UNIX domain endpoint.
   boost::asio::local::detail::endpoint impl_;
 };
 
 /// Output an endpoint as a string.
 /**
  * Used to output a human-readable string for a specified endpoint.
  *
  * @param os The output stream to which the string will be written.
  *
  * @param endpoint The endpoint to be written.
  *
  * @return The output stream.
  *
  * @relates boost::asio::local::basic_endpoint
  */
 template <typename Elem, typename Traits, typename Protocol>
 std::basic_ostream<Elem, Traits>& operator<<(
     std::basic_ostream<Elem, Traits>& os,
     const basic_endpoint<Protocol>& endpoint)
 {
   os << endpoint.path();
   return os;
 }
 
 } // namespace local
 } // namespace asio
 } // namespace boost
 
 #include <boost/asio/detail/pop_options.hpp>
 
 #endif // defined(BOOST_ASIO_HAS_LOCAL_SOCKETS)
        //   || defined(GENERATING_DOCUMENTATION)
 
 #endif // BOOST_ASIO_LOCAL_BASIC_ENDPOINT_HPP

This page was automatically generated by the 2.3.7 LXR engine. The LXR team