/*
 *     .============.
 *    //  M A K E  / \
 *   //  C++ DEV  /   \
 *  //  E A S Y  /  \/ \
 * ++ ----------.  \/\  .
 *  \\     \     \ /\  /
 *   \\     \     \   /
 *    \\     \     \ /
 *     -============'
 *
 * Copyright (c) 2018 Hevake and contributors, all rights reserved.
 *
 * This file is part of cpp-tbox (https://github.com/cpp-main/cpp-tbox)
 * Use of this source code is governed by MIT license that can be found
 * in the LICENSE file in the root of the source tree. All contributing
 * project authors may be found in the CONTRIBUTORS.md file in the root
 * of the source tree.
 */
#ifndef TBOX_NETWORK_SOCKET_FD_H_20171105
#define TBOX_NETWORK_SOCKET_FD_H_20171105

#include <sys/socket.h>

#include <tbox/util/fd.h>

namespace tbox {
namespace network {

//! socket 文件描述符
class SocketFd : public util::Fd {
  public:
    SocketFd();
    SocketFd(int fd);
    SocketFd(const Fd &fd);

    using Fd::operator=;
    using Fd::swap;

    //! 显式声明拷贝构造与拷贝赋值，消除 GCC -Wdeprecated-copy 警告
    SocketFd(const SocketFd &other) : Fd(other) { }
    SocketFd& operator=(const SocketFd &other) { return static_cast<SocketFd&>(Fd::operator=(other)); }

  public:
    static SocketFd CreateSocket(int domain, int type, int protocal);
    static SocketFd CreateUdpSocket();
    static SocketFd CreateTcpSocket();

  public: //! socket相关的操作
    int connect(const struct sockaddr *addr, socklen_t addrlen);

    int bind(const struct sockaddr *addr, socklen_t addrlen);
    int listen(int backlog);
    int accept(struct sockaddr *addr, socklen_t *addrlen);

    ssize_t send(const void* data_ptr, size_t data_size, int flag);
    ssize_t recv(void *data_ptr, size_t data_size, int flag);

    ssize_t sendTo(const void* data_ptr, size_t data_size, int flag,
                   const sockaddr *dest_addr, socklen_t addrlen);
    ssize_t recvFrom(void* data_ptr, size_t data_size, int flag,
                     sockaddr *dest_addr, socklen_t *addrlen);

    int shutdown(int howto);

  public: //! socket相关的设置
    bool getSocketOpt(int level, int optname, void *optval, socklen_t *optlen);
    bool setSocketOpt(int level, int optname, int optval);
    bool setSocketOpt(int level, int optname, const void *optval, socklen_t optlen);

    bool setReuseAddress(bool enable);  //! 设置可重用地址
    bool setBroadcast(bool enable);     //! 设置是否允许广播
    bool setKeepalive(bool enable);     //! 设置是否开启保活

    bool setRecvBufferSize(int size);   //! 设置接收缓冲大小
    bool setSendBufferSize(int size);   //! 设置发送缓冲大小

    bool setRecvLowWater(int size);     //! 设置接收低水位标记
    bool setSendLowWater(int size);     //! 设置发送低水位标记

    bool setLinger(bool enable, int linger = 0);    //! 设置延迟关闭
};

}
}

#endif //TBOX_NETWORK_SOCKET_FD_H_20171105