MulticastSocket.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_MulticastSocket_hxx
#define __ccxx_MulticastSocket_hxx

#include <commonc++/Common.h++>
#include <commonc++/DatagramSocket.h++>
#include <commonc++/NetworkInterface.h++>
#include <commonc++/String.h++>

namespace ccxx {

class COMMONCPP_API MulticastSocket : public DatagramSocket
{
 public:

  MulticastSocket(uint16_t port = 0);

  ~MulticastSocket();

  void join(const String& address);

  void join(const InetAddress& address);

  void join(const String& address, const NetworkInterface& ixface);

  void join(const InetAddress& address, const NetworkInterface& ixface);

  void leave(const String& address);

  void leave(const InetAddress& address);

  void leave(const String& address, const ccxx::NetworkInterface& ixface);

  void leave(const InetAddress& address,
             const ccxx::NetworkInterface& ixface);

  void setTTL(uint8_t ttl);

  uint8_t getTTL() const;

  void setLoopbackEnabled(bool enabled);

  bool isLoopbackEnabled() const;

  static uint8_t TTL_HOST;
  static uint8_t TTL_SUBNET;
  static uint8_t TTL_SITE;
  static uint8_t TTL_REGION;
  static uint8_t TTL_CONTINENT;
  static uint8_t TTL_UNRESTRICTED;

 private:

  void verifyAddress(const InetAddress& address);

  uint16_t _port;

  CCXX_COPY_DECLS(MulticastSocket);
};

} // namespace ccxx

#endif // __ccxx_MulticastSocket_hxx