libmicrohttpd2

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

mhd_iovec.h (4141B)

      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) 2024 Evgeny Grin (Karlson2k)
      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_iovec.h
     41  * @brief  The definition of the tristate type and helper macros
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_IOVEC_H
     46 #define MHD_IOVEC_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 #include "mhd_socket_type.h"
     50 #include "sys_base_types.h"
     51 
     52 #if defined(HAVE_WRITEV) || defined(HAVE_SENDMSG)
     53 #  ifdef HAVE_SYS_TYPES_H
     54 #    include <sys/types.h>
     55 #  endif
     56 #  ifdef HAVE_SYS_SOCKET_H
     57 #    include <sys/socket.h>
     58 #  elif defined(HAVE_UNISTD_H)
     59 #    include <unistd.h>
     60 #  endif
     61 #  ifdef HAVE_SOCKLIB_H
     62 #    include <sockLib.h>
     63 #  endif
     64 #  ifdef HAVE_SYS_UIO_H
     65 #    include <sys/uio.h>
     66 #  endif
     67 #endif
     68 
     69 #include "mhd_limits.h"
     70 
     71 #if defined(MHD_SOCKETS_KIND_WINSOCK)
     72 /**
     73  * Internally used I/O vector type for use with winsock.
     74  * Binary matches system "WSABUF".
     75  */
     76 struct mhd_w32_iovec
     77 {
     78   unsigned long iov_len;
     79   char *iov_base;
     80 };
     81 typedef struct mhd_w32_iovec mhd_iovec;
     82 #define mhd_IOV_ELMN_MAX_SIZE    ULONG_MAX
     83 #define mhd_IOV_ELMN_PTR_TYPE    char *
     84 typedef unsigned long mhd_iov_elmn_size;
     85 #define mhd_IOV_RET_MAX_SIZE    LONG_MAX
     86 typedef long mhd_iov_ret_type;
     87 #elif defined(HAVE_SENDMSG) || defined(HAVE_WRITEV)
     88 /**
     89  * Internally used I/O vector type for use when writev or sendmsg
     90  * is available. Matches system "struct iovec".
     91  */
     92 typedef struct iovec mhd_iovec;
     93 #define mhd_IOV_ELMN_MAX_SIZE    SIZE_MAX
     94 #define mhd_IOV_ELMN_PTR_TYPE    void *
     95 typedef size_t mhd_iov_elmn_size;
     96 #define mhd_IOV_RET_MAX_SIZE     SSIZE_MAX
     97 typedef ssize_t mhd_iov_ret_type;
     98 #else
     99 /**
    100  * Internally used I/O vector type for use when writev or sendmsg
    101  * is not available.
    102  */
    103 typedef struct MHD_IoVec mhd_iovec;
    104 #define mhd_IOV_ELMN_MAX_SIZE    SIZE_MAX
    105 #define mhd_IOV_ELMN_PTR_TYPE    void *
    106 typedef size_t mhd_iov_elmn_size;
    107 #define mhd_IOV_RET_MAX_SIZE     SSIZE_MAX
    108 typedef ssize_t mhd_iov_ret_type;
    109 #endif
    110 
    111 
    112 struct mhd_iovec_track
    113 {
    114   /**
    115    * The copy of array of iovec elements.
    116    * The copy of elements are updated during sending.
    117    * The number of elements is not changed during lifetime.
    118    */
    119   mhd_iovec *iov;
    120 
    121   /**
    122    * The number of elements in @a iov.
    123    * This value is not changed during lifetime.
    124    */
    125   size_t cnt;
    126 
    127   /**
    128    * The number of sent elements.
    129    * At the same time, it is the index of the next (or current) element
    130    * to send.
    131    */
    132   size_t sent;
    133 };
    134 
    135 #endif /* ! MHD_IOVEC_H */