UDPSocket.h

Go to the documentation of this file.

// Remote - send I/Q samples read from a SDR device over the network via UDP.    //
//                                                                               //
// Copyright (C) 2015 Edouard Griffiths, F4EXB                                   //
//                                                                               //
// This program is free software; you can redistribute it and/or modify          //
// it under the terms of the GNU General Public License as published by          //
// the Free Software Foundation as version 3 of the License, or                  //
// (at your option) any later version.                                           //
//                                                                               //
// This program is distributed in the hope that it will be useful,               //
// but WITHOUT ANY WARRANTY; without even the implied warranty of                //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                  //
// GNU General Public License V3 for more details.                               //
//                                                                               //
// You should have received a copy of the GNU General Public License             //
// along with this program. If not, see <http://www.gnu.org/licenses/>.          //

// Original code is posted at: https://cppcodetips.wordpress.com/2014/01/29/udp-socket-class-in-c/

#ifndef INCLUDE_UDPSOCKET_H_
#define INCLUDE_UDPSOCKET_H_

#include <cstring>            // For string
#include <exception>         // For exception class
#include <string>
#include <sys/types.h>       // For data types
#include <sys/socket.h>      // For socket(), connect(), send(), and recv()
#include <netdb.h>           // For gethostbyname()
#include <arpa/inet.h>       // For inet_addr()
#include <unistd.h>          // For close()
#include <netinet/in.h>      // For sockaddr_in
#include <errno.h>
#include <climits>

using namespace std;

class CSocketException: public std::exception
{
public:
    CSocketException(const string &message, bool bSysMsg = false) throw();


    virtual ~CSocketException() throw ();

    virtual const char* what() const throw (){  return m_sMsg.c_str(); }

protected:
    std::string m_sMsg;
};

class CSocket
{
public:
    virtual ~CSocket();

    enum SocketType
    {
        TcpSocket = SOCK_STREAM,
        UdpSocket = SOCK_DGRAM,
        UnknownSocketType =-1
    };

    enum NetworkLayerProtocol
    {
        IPv4Protocol = AF_INET,
        IPv6Protocol = AF_INET6,
        UnknownNetworkLayerProtocol = -1
    };

    enum ReadResult
    {
       DATA_ARRIVED   = 0,
       DATA_TIMED_OUT = ETIMEDOUT,
       DATA_EXCEPTION = 255
    };

    string GetLocalAddress();

    unsigned short GetLocalPort();


    void BindLocalPort(unsigned short localPort);

    void BindLocalAddressAndPort(const string &localAddress, unsigned short localPort = 0);

    unsigned long int GetReadBufferSize ();

    void SetReadBufferSize(unsigned int nSize);

    void SetNonBlocking(bool bBlocking);

    void ConnectToHost(const string &foreignAddress, unsigned short foreignPort);

    void Send(const void *buffer, int bufferLen);

    int Recv(void *buffer, int bufferLen);

    string GetPeerAddress();

    unsigned short GetPeerPort();

    CSocket& operator<<(const string& sStr );

    CSocket& operator>>(string& sStr);

    virtual int OnDataRead(unsigned long timeToWait = ULONG_MAX);

    void SetBindToDevice(const string& sInterface);

protected:
    int m_sockDesc;

    CSocket(SocketType type, NetworkLayerProtocol protocol);
    CSocket(int sockDesc);
    static void FillAddr( const string & localAddress, unsigned short localPort, sockaddr_in& localAddr );

private:
    // Prevent the user from trying to use Exact copy of this object
    CSocket(const CSocket &sock);
    void operator=(const CSocket &sock);
};

class UDPSocket : public CSocket
{
public:
    UDPSocket();
    UDPSocket(unsigned short localPort);

    UDPSocket(const string &localAddress, unsigned short localPort);

    void DisconnectFromHost();

    void SendDataGram(const void *buffer, int bufferLen, const string &foreignAddress,
        unsigned short foreignPort);

    int RecvDataGram(void *buffer, int bufferLen, string &sourceAddress,
               unsigned short &sourcePort);

    void SetMulticastTTL(unsigned char multicastTTL);

    void JoinGroup(const string &multicastGroup);

    void LeaveGroup(const string &multicastGroup);

private:
    void SetBroadcast();

};


#endif /* INCLUDE_UDPSOCKET_H_ */