nrg_socket.h

Go to the documentation of this file.

/*
  LibNRG - Networking for Real-time Games
  
  Copyright (C) 2012-2014 Alex Baines <alex@abaines.me.uk>

  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 NRG_SOCKET_H
#define NRG_SOCKET_H
#include "nrg_core.h"
#include "nrg_netaddress.h"
#include "nrg_packet.h"
#include <memory>

namespace nrg {

class Socket {
public:
    Socket(int type, int family = PF_UNSPEC);
    Socket(int type, const NetAddress& addr);
    
    void setFamilyFromAddress(const NetAddress& addr);
    
    Status bind(const NetAddress& addr);
    
    Status connect(const NetAddress& addr);
    
    void disconnect();
    
    bool isConnected() const;
    
    Status sendPacket(const Packet& p) const;
    
    Status sendPacket(const Packet& p, const NetAddress& addr) const;
    
    Status recvPacket(Packet& p) const;
    
    Status recvPacket(Packet& p, NetAddress& addr);
    
    template<typename T>
    bool setOption(int level, int name, const T& opt){
         return setsockopt(fd, level, name, &opt, sizeof(T)) == 0;
    }
    
    bool dataPending(int usToBlock = 0) const;
    
    void setNonBlocking(bool nonblock);
    
    void enableTimestamps(bool enable);
    
    void handleUnconnectedICMPErrors(bool enable);
    
    const std::unique_ptr<NetAddress>& getBoundAddress() const;
    
    const std::unique_ptr<NetAddress>& getConnectedAddress() const {
        return connected_addr;
    }
    
    uint64_t getLastTimestamp() const {
        return last_timestamp;
    }
    
    virtual ~Socket();
private:    
    Status checkErrorQueue(NetAddress& culprit);
    
    mutable std::unique_ptr<NetAddress> bound_addr, connected_addr;
    int fd, family, type;
    bool do_timestamp, use_errqueue;
    uint64_t last_timestamp;
};

struct UDPSocket : public Socket {
    UDPSocket(int family = PF_UNSPEC);
    UDPSocket(const NetAddress& a);
};

}

#endif