123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129 |
- //
- // generic/stream_protocol.hpp
- // ~~~~~~~~~~~~~~~~~~~~~~~~~~~
- //
- // Copyright (c) 2003-2021 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 http://www.boost.org/LICENSE_1_0.txt)
- //
- #ifndef BOOST_ASIO_GENERIC_STREAM_PROTOCOL_HPP
- #define BOOST_ASIO_GENERIC_STREAM_PROTOCOL_HPP
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
- #include <boost/asio/detail/config.hpp>
- #include <typeinfo>
- #include <boost/asio/basic_socket_iostream.hpp>
- #include <boost/asio/basic_stream_socket.hpp>
- #include <boost/asio/detail/socket_types.hpp>
- #include <boost/asio/detail/throw_exception.hpp>
- #include <boost/asio/generic/basic_endpoint.hpp>
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- namespace generic {
- /// Encapsulates the flags needed for a generic stream-oriented socket.
- /**
- * The boost::asio::generic::stream_protocol class contains flags necessary for
- * stream-oriented sockets of any address family and protocol.
- *
- * @par Examples
- * Constructing using a native address family and socket protocol:
- * @code stream_protocol p(AF_INET, IPPROTO_TCP); @endcode
- * Constructing from a specific protocol type:
- * @code stream_protocol p(boost::asio::ip::tcp::v4()); @endcode
- *
- * @par Thread Safety
- * @e Distinct @e objects: Safe.@n
- * @e Shared @e objects: Safe.
- *
- * @par Concepts:
- * Protocol.
- */
- class stream_protocol
- {
- public:
- /// Construct a protocol object for a specific address family and protocol.
- stream_protocol(int address_family, int socket_protocol)
- : family_(address_family),
- protocol_(socket_protocol)
- {
- }
- /// Construct a generic protocol object from a specific protocol.
- /**
- * @throws @c bad_cast Thrown if the source protocol is not stream-oriented.
- */
- template <typename Protocol>
- stream_protocol(const Protocol& source_protocol)
- : family_(source_protocol.family()),
- protocol_(source_protocol.protocol())
- {
- if (source_protocol.type() != type())
- {
- std::bad_cast ex;
- boost::asio::detail::throw_exception(ex);
- }
- }
- /// Obtain an identifier for the type of the protocol.
- int type() const BOOST_ASIO_NOEXCEPT
- {
- return BOOST_ASIO_OS_DEF(SOCK_STREAM);
- }
- /// Obtain an identifier for the protocol.
- int protocol() const BOOST_ASIO_NOEXCEPT
- {
- return protocol_;
- }
- /// Obtain an identifier for the protocol family.
- int family() const BOOST_ASIO_NOEXCEPT
- {
- return family_;
- }
- /// Compare two protocols for equality.
- friend bool operator==(const stream_protocol& p1, const stream_protocol& p2)
- {
- return p1.family_ == p2.family_ && p1.protocol_ == p2.protocol_;
- }
- /// Compare two protocols for inequality.
- friend bool operator!=(const stream_protocol& p1, const stream_protocol& p2)
- {
- return !(p1 == p2);
- }
- /// The type of an endpoint.
- typedef basic_endpoint<stream_protocol> endpoint;
- /// The generic socket type.
- typedef basic_stream_socket<stream_protocol> socket;
- #if !defined(BOOST_ASIO_NO_IOSTREAM)
- /// The generic socket iostream type.
- typedef basic_socket_iostream<stream_protocol> iostream;
- #endif // !defined(BOOST_ASIO_NO_IOSTREAM)
- private:
- int family_;
- int protocol_;
- };
- } // namespace generic
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #endif // BOOST_ASIO_GENERIC_STREAM_PROTOCOL_HPP
|