libmicrohttpd2

HTTP server C library (MHD 2.x, alpha)
Log | Files | Refs | README | LICENSE

mhd_sockets_funcs.h (3916B)

      1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */
      2 /*
      3   This file is part of GNU libmicrohttpd.
      4   Copyright (C) 2014-2024 Karlson2k (Evgeny Grin)
      5 
      6   GNU libmicrohttpd is free software; you can redistribute it and/or
      7   modify it under the terms of the GNU Lesser General Public
      8   License as published by the Free Software Foundation; either
      9   version 2.1 of the License, or (at your option) any later version.
     10 
     11   GNU libmicrohttpd is distributed in the hope that it will be useful,
     12   but WITHOUT ANY WARRANTY; without even the implied warranty of
     13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     14   Lesser General Public License for more details.
     15 
     16   Alternatively, you can redistribute GNU libmicrohttpd and/or
     17   modify it under the terms of the GNU General Public License as
     18   published by the Free Software Foundation; either version 2 of
     19   the License, or (at your option) any later version, together
     20   with the eCos exception, as follows:
     21 
     22     As a special exception, if other files instantiate templates or
     23     use macros or inline functions from this file, or you compile this
     24     file and link it with other works to produce a work based on this
     25     file, this file does not by itself cause the resulting work to be
     26     covered by the GNU General Public License. However the source code
     27     for this file must still be made available in accordance with
     28     section (3) of the GNU General Public License v2.
     29 
     30     This exception does not invalidate any other reasons why a work
     31     based on this file might be covered by the GNU General Public
     32     License.
     33 
     34   You should have received copies of the GNU Lesser General Public
     35   License and the GNU General Public License along with this library;
     36   if not, see <https://www.gnu.org/licenses/>.
     37 */
     38 
     39 /**
     40  * @file src/mhd2/mhd_sockets_funcs.h
     41  * @brief  Declarations for sockets manipulating functions
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_SOCKETS_FUNCS_H
     46 #define MHD_SOCKETS_FUNCS_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #include "sys_bool_type.h"
     51 #include "mhd_socket_type.h"
     52 
     53 
     54 /**
     55  * Change socket options to be non-blocking.
     56  *
     57  * @param sckt the socket to manipulate
     58  * @return true on success, false otherwise
     59  */
     60 MHD_INTERNAL bool
     61 mhd_socket_nonblocking (MHD_Socket sckt);
     62 
     63 /**
     64  * Change socket options to be non-inheritable.
     65  *
     66  * @param sckt the socket to manipulate
     67  * @return true on success, false otherwise
     68  */
     69 MHD_INTERNAL bool
     70 mhd_socket_noninheritable (MHD_Socket sckt);
     71 
     72 /**
     73  * Change socket options to be closed "hard".
     74  *
     75  * @param sckt the socket to manipulate
     76  * @return true on success, false otherwise
     77  */
     78 MHD_INTERNAL bool
     79 mhd_socket_set_hard_close (MHD_Socket sckt);
     80 
     81 /**
     82  * Shutdown sending on socket
     83  *
     84  * @param sckt the socket to manipulate
     85  * @return true on success, false otherwise
     86  */
     87 MHD_INTERNAL bool
     88 mhd_socket_shut_wr (MHD_Socket sckt);
     89 
     90 /**
     91  * Control Nagle's algorithm on @a sock.
     92  *
     93  * @param sckt the socket to manipulate
     94  * @param on the value to use: true to set "no delay" (disable Nagle's
     95  *           algorithm), false to clear "no delay" (enable Nagle's algorithm)
     96  * @return true on success, false otherwise
     97  */
     98 MHD_INTERNAL bool
     99 mhd_socket_set_nodelay (MHD_Socket sckt,
    100                         bool on);
    101 
    102 
    103 #ifndef HAVE_SOCKETPAIR
    104 
    105 #  define mhd_socket_pair(fdarr_ptr) mhd_socket_pair_func (fdarr_ptr, false)
    106 #  define mhd_socket_pair_nblk(fdarr_ptr) mhd_socket_pair_func (fdarr_ptr, true)
    107 
    108 
    109 /**
    110  * Create pair of mutually connected sockets on loopback address
    111  * @param sockets_pair the array to receive resulted sockets
    112  * @param non_blk if set to true, sockets created in non-blocking mode
    113  *                otherwise sockets will be in blocking mode
    114  * @return true if succeeded, false otherwise
    115  */
    116 MHD_INTERNAL bool
    117 mhd_socket_pair_func (MHD_Socket sckt[2], bool non_blk);
    118 
    119 #endif /* ! HAVE_SOCKETPAIR */
    120 
    121 
    122 #endif /* ! MHD_SOCKETS_FUNCS_H */