TcpSocket.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_TCP_SOCKET_H
#define GF_TCP_SOCKET_H

#include <cstdint>
#include <string>

#include "NetApi.h"
#include "Socket.h"
#include "Span.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif
  struct Packet;

  class GF_NET_API TcpSocket : public Socket {
  public:
    TcpSocket() = default;

    TcpSocket(const std::string& hostname, const std::string& service, SocketFamily family = SocketFamily::Unspec);

    TcpSocket(const TcpSocket&) = delete;

    TcpSocket& operator=(const TcpSocket&) = delete;

    TcpSocket(TcpSocket&&) = default;

    TcpSocket& operator=(TcpSocket&&) = default;

    ~TcpSocket();

    SocketAddress getRemoteAddress() const;

    SocketDataResult sendRawBytes(Span<const uint8_t> buffer);

    SocketDataResult recvRawBytes(Span<uint8_t> buffer);

    SocketStatus sendBytes(Span<const uint8_t> buffer);

    SocketStatus recvBytes(Span<uint8_t> buffer);

    SocketStatus sendPacket(const Packet& packet);

    SocketStatus recvPacket(Packet& packet);

  private:
    TcpSocket(SocketHandle handle);

    friend class TcpListener;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_TCP_SOCKET_H