multicasttunnelsocket.h

Go to the documentation of this file.

/*
    
  This file is a part of ENUt, a library containing network
  programming utilities.
  
  Copyright (C) 2006-2008  Hasselt University - Expertise Centre for
                      Digital Media (EDM) (http://www.edm.uhasselt.be)

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  
  USA

*/

#ifndef NUT_MULTICASTTUNNELSOCKET_H

#define NUT_MULTICASTTUNNELSOCKET_H

#include "nutconfig.h"

#ifdef NUTCONFIG_SUPPORT_ENET

#include "datagramsocket.h"
#include "enetsocket.h"
#include <list>

namespace nut
{

class IPv4Address;
class UDPSocket;
        
class ENUT_IMPORTEXPORT MulticastTunnelSocket : public DatagramSocket
{
public:
        MulticastTunnelSocket();

        MulticastTunnelSocket(const std::string &objName);

        ~MulticastTunnelSocket();
        
        bool create(const IPv4Address &serverAddr, uint16_t serverPort, uint16_t mcastRemotePortNumber);

        bool destroy();

        uint16_t getLocalPortNumber() const;

        bool joinMulticastGroup(const NetworkLayerAddress &groupAddress);
        bool leaveMulticastGroup(const NetworkLayerAddress &groupAddress);

        bool write(const void *pData, size_t &length, const NetworkLayerAddress &destinationAddress, uint16_t destinationPort);
        
        bool getAvailableDataLength(size_t &length, bool &available);
        bool read(void *buffer, size_t &bufferSize);

        const NetworkLayerAddress *getLastSourceAddress() const;
        uint16_t getLastSourcePort() const;
        const NetworkLayerAddress *getLastDestinationAddress() const;
protected:
        ENetSocket getSocketDescriptor()                                                                { return m_pEnetSocket->getSocketDescriptor(); }
private:
        // Make sure we can't copy the socket
        MulticastTunnelSocket(const MulticastTunnelSocket &s) : DatagramSocket(s)                       { }
        MulticastTunnelSocket &operator=(const MulticastTunnelSocket &s)                                { }
        
        class Packet
        {
        public:
                Packet(uint8_t *pBuf, size_t length, NetworkLayerAddress *pSrcAddr, uint16_t srcPort,
                       NetworkLayerAddress *pDstAddr)
                {
                        m_pBuf = pBuf;
                        m_length = length;
                        m_pSrcAddr = pSrcAddr;
                        m_srcPort = srcPort;
                        m_pDstAddr = pDstAddr;
                }

                ~Packet()
                {
                        delete [] m_pBuf;
                        delete m_pSrcAddr;
                        delete m_pDstAddr;
                }

                uint8_t *getBuffer() const                                                              { return m_pBuf + sizeof(uint16_t)+sizeof(uint32_t)*2; }
                size_t getLength() const                                                                { return m_length - sizeof(uint16_t)-sizeof(uint32_t)*2; }
                const NetworkLayerAddress *getSourceAddress() const                                     { return m_pSrcAddr; }
                uint16_t getSourcePort() const                                                          { return m_srcPort; }
                const NetworkLayerAddress *getDestinationAddress() const                                { return m_pDstAddr; }
        private:
                uint8_t *m_pBuf;
                size_t m_length;
                NetworkLayerAddress *m_pSrcAddr, *m_pDstAddr;
                uint16_t m_srcPort;
        };
        
        bool poll();
        bool writeCommand(uint8_t cmdNum, uint8_t *pData = 0, size_t length = 0);
        
        ENETSocket *m_pEnetSocket;
        std::list<Packet *> m_packets;
        Packet *m_pLastReadPacket;
        bool m_init;
};
        
}

#endif // NUTCONFIG_SUPPORT_ENET

#endif // NUT_MULTICASTTUNNELSOCKET_H