Ssdp.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base 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 3 of the
 * License, or (at your option) any later version.
 * 
 * libhomegear-base 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 libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef SSDP_H_
#define SSDP_H_

#include "../Encoding/Http.h"
#include "../Variable.h"

#include <string>
#include <vector>
#include <memory>
#include <set>
#include <unordered_map>
#include <atomic>

namespace BaseLib {

class SharedObjects;
class FileDescriptor;

class SsdpInfo {
 public:
  SsdpInfo();
  SsdpInfo(std::string ip, int32_t port, std::string path, PVariable info);
  virtual ~SsdpInfo();
  std::string ip() { return _ip; }
  void setIp(std::string value) { _ip = value; }
  int32_t port() { return _port; }
  void setPort(int32_t value) { _port = value; }
  void setPath(std::string value) { _path = value; }
  std::string location() { return _location; }
  void setLocation(std::string value) { _location = value; }
  const PVariable info() { return _info; }
  void setInfo(PVariable value) { _info = value; }
  void addField(std::string key, std::string value) { _fields.emplace(key, value); }
  std::string getField(std::string key) {
    auto fieldsIterator = _fields.find(key);
    if (fieldsIterator != _fields.end()) return fieldsIterator->second; else return "";
  }
  std::unordered_map<std::string, std::string> &getFields() { return _fields; };
 private:
  std::string _ip;
  int32_t _port;
  std::string _path;
  std::string _location;
  PVariable _info;
  std::unordered_map<std::string, std::string> _fields;
};

class Ssdp {
 public:
  Ssdp(BaseLib::SharedObjects *baseLib);
  virtual ~Ssdp();

  void searchDevices(const std::string &stHeader, uint32_t timeout, std::vector<SsdpInfo> &devices);

  void searchDevicesPassive(const std::string &stHeader, uint32_t timeout, std::vector<SsdpInfo> &devices, std::atomic_bool &abort);
 private:
  BaseLib::SharedObjects *_bl = nullptr;
  std::string _address;

  void getAddress();
  void sendSearchBroadcast(std::shared_ptr<FileDescriptor> &serverSocketDescriptor, const std::string &stHeader, uint32_t timeout);
  void processPacket(Http &http, const std::string &stHeader, std::map<std::string, SsdpInfo> &info);
  void processPacketPassive(Http &http, const std::string &stHeader, std::map<std::string, SsdpInfo> &info);
  void getDeviceInfo(std::map<std::string, SsdpInfo> &info, std::vector<SsdpInfo> &devices);
  std::shared_ptr<FileDescriptor> getSocketDescriptor(int32_t port, bool bindToMulticast);
};

}
#endif