Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 1.8 KB

Connection.rst

File metadata and controls

49 lines (26 loc) · 1.8 KB
Raw

Connection

.. cpp:namespace-push:: show


.. cpp:class:: connection

    Objects of this type represent a connection between a single client and a server.  A connection object can be used to generate :cpp:class:`request` objects; one in the case of HTTP/1.0 or multiple in the case of HTTP/1.1.

    The connection class has no public constructor (besides the move constructor), and can only be created by calling :cpp:func:`server::serve()`.

    .. cpp:function:: connection( connection&& )

        Explicit `move constructor`_ as one can't be generated for this class

        .. _move constructor: http://en.cppreference.com/w/cpp/language/move_constructor

    .. cpp:function:: ~connection()

        Destructor for a connection, which closes it; any requests or responses created on this connection can no longer be read from or written to

    .. cpp:function:: const std::string& client_address() const

        The IP address of the connected client

    .. cpp:function:: unsigned int client_port() const

        The port of the connected client

    .. cpp:function:: const std::string& server_address() const

        The address of the server handling the connection

    .. cpp:function:: unsigned int server_port() const

        The port of the server handling the connection

    .. cpp:function:: int timeout() const

        Get the current timeout of this connection, initially inherited from the server the connection is created from

    .. cpp:function:: int timeout( int )

        Set the timeout of this connection independently of the server; the argument is a number of seconds, 0, or -1

        .. seealso::

            * :cpp:func:`server::timeout()`