third_party/ot-br-posix/repo/src/utils/socket_utils.hpp

   1 /*
   2  *  Copyright (c) 2021, The OpenThread Authors.
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *  1. Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  *  2. Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *  3. Neither the name of the copyright holder nor the
  13  *     names of its contributors may be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *  POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef OTBR_UTILS_SOCKET_UTILS_HPP_
  30 #define OTBR_UTILS_SOCKET_UTILS_HPP_
  31
  32 #include "openthread-br/config.h"
  33
  34 #include "common/code_utils.hpp"
  35
  36 #include <assert.h>
  37 #include <fcntl.h>
  38 #include <sys/socket.h>
  39 #include <unistd.h>
  40
  41 enum SocketBlockOption
  42 {
  43     kSocketBlock,    ///< The socket is blocking.
  44     kSocketNonBlock, ///< The socket is non-blocking.
  45 };
  46
  47 /**
  48  * This function creates a socket with SOCK_CLOEXEC flag set.
  49  *
  50  * @param[in]   aDomain       The communication domain.
  51  * @param[in]   aType         The semantics of communication.
  52  * @param[in]   aProtocol     The protocol to use.
  53  * @param[in]   aBlockOption  Whether to add nonblock flags.
  54  *
  55  * @returns The file descriptor of the created socket.
  56  *
  57  * @retval  -1  Failed to create socket.
  58  *
  59  */
  60 int SocketWithCloseExec(int aDomain, int aType, int aProtocol, SocketBlockOption aBlockOption);
  61
  62 #endif // OTBR_UTILS_SOCKET_UTILS_HPP_