SocketTypes.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_SOCKET_TYPES_H
#define GF_SOCKET_TYPES_H

#include <cstddef>

#ifdef _WIN32
#include <winsock2.h>
#endif

#include "NetApi.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifdef _WIN32
  using SocketHandle = SOCKET;
  constexpr SocketHandle InvalidSocketHandle = INVALID_SOCKET;
#else
  using SocketHandle = int;
  constexpr SocketHandle InvalidSocketHandle = -1;
#endif
#else

  using SocketHandle = implementation-defined;

  constexpr SocketHandle InvalidSocketHandle = implemetation-defined;
#endif

  enum class SocketStatus {
    Data,   
    Block,  
    Close,  
    Error,  
  };

  struct GF_NET_API SocketDataResult {
    SocketStatus status;  
    std::size_t length;   
  };

  enum class SocketSelectorStatus {
    Event,    
    Timeout,  
    Error,    
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_SOCKET_TYPES_H