cdirectory.hxx

/* Copyright (C) 2006-2016 J.F.Dockes
 *
 * 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 Street, Fifth Floor, Boston, MA
 *   02110-1301 USA
 */
#ifndef _UPNPDIR_HXX_INCLUDED_
#define _UPNPDIR_HXX_INCLUDED_

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

#include "libupnpp/control/service.hxx"

namespace UPnPClient {

class ContentDirectory;
class UPnPDeviceDesc;
class UPnPDirContent;
class UPnPServiceDesc;

typedef std::shared_ptr<ContentDirectory> CDSH;

class UPNPP_API ContentDirectory : public Service {
public:

    ContentDirectory(const UPnPDeviceDesc& dev, const UPnPServiceDesc& srv);
    virtual ~ContentDirectory() {}

    ContentDirectory() {}

    enum ServiceKind {CDSKIND_UNKNOWN, CDSKIND_BUBBLE, CDSKIND_MEDIATOMB,
                      CDSKIND_MINIDLNA, CDSKIND_MINIM, CDSKIND_TWONKY
                     };

    ServiceKind getKind() {
        return m_serviceKind;
    }

    static bool isCDService(const std::string& st);
    virtual bool serviceTypeMatch(const std::string& tp);

    static bool getServices(std::vector<CDSH>&);

    static bool getServerByName(const std::string& friendlyName,
                                CDSH& server);

    int readDir(const std::string& objectId, UPnPDirContent& dirbuf);

    int readDirSlice(const std::string& objectId, int offset,
                     int count, UPnPDirContent& dirbuf,
                     int *didread, int *total);

    int goodSliceSize()
    {
        return m_rdreqcnt;
    }

    int search(const std::string& objectId, const std::string& searchstring,
               UPnPDirContent& dirbuf);
    int searchSlice(const std::string& objectId,
                    const std::string& searchstring,
                    int offset, int count, UPnPDirContent& dirbuf,
                    int *didread, int *total);

    int getMetadata(const std::string& objectId, UPnPDirContent& dirbuf);

    int getSearchCapabilities(std::set<std::string>& result);

protected:
    virtual bool serviceInit(const UPnPDeviceDesc& device,
                             const UPnPServiceDesc& service);
    /* My service type string */
    static const std::string SType;

private:
    int m_rdreqcnt{200}; // Slice size to use when reading
    ServiceKind m_serviceKind{CDSKIND_UNKNOWN};

    void UPNPP_LOCAL
        evtCallback(const std::unordered_map<std::string, std::string>&);
    void UPNPP_LOCAL registerCallback();
};

}

#endif /* _UPNPDIR_HXX_INCLUDED_ */