TLA  Line data    Source code

       1                 : //
       2                 : // Copyright (c) 2026 Steve Gerbino
       3                 : //
       4                 : // Distributed under the Boost Software License, Version 1.0. (See accompanying
       5                 : // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       6                 : //
       7                 : // Official repository: https://github.com/cppalliance/corosio
       8                 : //
       9                 : 
      10                 : #ifndef BOOST_COROSIO_DETAIL_SOCKET_SERVICE_HPP
      11                 : #define BOOST_COROSIO_DETAIL_SOCKET_SERVICE_HPP
      12                 : 
      13                 : #include <boost/corosio/detail/config.hpp>
      14                 : #include <boost/corosio/tcp_socket.hpp>
      15                 : #include <boost/capy/ex/execution_context.hpp>
      16                 : #include <system_error>
      17                 : 
      18                 : namespace boost::corosio::detail {
      19                 : 
      20                 : /** Abstract socket service base class.
      21                 : 
      22                 :     Concrete implementations ( epoll_sockets, select_sockets, etc. )
      23                 :     inherit from this class and provide platform-specific socket
      24                 :     operations. The context constructor installs whichever backend
      25                 :     via `make_service`, and `tcp_socket.cpp` retrieves it via
      26                 :     `use_service<socket_service>()`.
      27                 : */
      28                 : class BOOST_COROSIO_DECL socket_service
      29                 :     : public capy::execution_context::service
      30                 :     , public io_object::io_service
      31                 : {
      32                 : public:
      33                 :     /// Identifies this service for `execution_context` lookup.
      34                 :     using key_type = socket_service;
      35                 : 
      36                 :     /** Open a socket.
      37                 : 
      38                 :         Creates a socket and associates it with the platform reactor.
      39                 : 
      40                 :         @param impl The socket implementation to open.
      41                 :         @param family Address family (e.g. `AF_INET`, `AF_INET6`).
      42                 :         @param type Socket type (e.g. `SOCK_STREAM`).
      43                 :         @param protocol Protocol number (e.g. `IPPROTO_TCP`).
      44                 :         @return Error code on failure, empty on success.
      45                 :     */
      46                 :     virtual std::error_code
      47                 :     open_socket( tcp_socket::implementation& impl,
      48                 :                  int family, int type, int protocol ) = 0;
      49                 : 
      50                 : protected:
      51                 :     /// Construct the socket service.
      52 HIT         378 :     socket_service() = default;
      53                 : 
      54                 :     /// Destroy the socket service.
      55             378 :     ~socket_service() override = default;
      56                 : };
      57                 : 
      58                 : } // namespace boost::corosio::detail
      59                 : 
      60                 : #endif // BOOST_COROSIO_DETAIL_SOCKET_SERVICE_HPP