servus.h

/* Copyright (c) 2012-2014, Stefan Eilemann <eile@eyescale.ch>
 *
 * This file is part of Lunchbox <https://github.com/Eyescale/Lunchbox>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * 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 LUNCHBOX_SERVUS_H
#define LUNCHBOX_SERVUS_H

#include <lunchbox/api.h>
#include <lunchbox/result.h> // nested base class
#include <lunchbox/types.h>
#include <boost/noncopyable.hpp>
#include <map>

namespace lunchbox
{
namespace detail { class Servus; }

class Servus : public boost::noncopyable
{
public:
    enum Interface
    {
        IF_ALL = 0, 
        // (uint32_t) -1 == kDNSServiceInterfaceIndexLocalOnly
        IF_LOCAL = (unsigned)(-1) 
    };

    class Result : public lunchbox::Result
    {
    public:
        explicit Result( const int32_t code ) : lunchbox::Result( code ){}
        virtual ~Result(){}
        LUNCHBOX_API std::string getString() const override;

        static const int32_t PENDING = -1;
        static const int32_t NOT_SUPPORTED = -2;
        static const int32_t POLL_ERROR = -3;
    };

    LUNCHBOX_API static bool isAvailable();

    LUNCHBOX_API explicit Servus( const std::string& name );

    LUNCHBOX_API virtual ~Servus();

    LUNCHBOX_API void set( const std::string& key, const std::string& value );

    LUNCHBOX_API Strings getKeys() const;

    LUNCHBOX_API const std::string& get( const std::string& key ) const;

    LUNCHBOX_API Result announce( const unsigned short port,
                                  const std::string& instance );

    LUNCHBOX_API void withdraw();

    LUNCHBOX_API bool isAnnounced() const;

    LUNCHBOX_API Strings discover( const Interface addr,
                                   const unsigned browseTime );

    LUNCHBOX_API Result beginBrowsing( const lunchbox::Servus::Interface addr );

    LUNCHBOX_API Result browse( int32_t timeout = -1 );

    LUNCHBOX_API void endBrowsing();

    LUNCHBOX_API bool isBrowsing() const;

    LUNCHBOX_API Strings getInstances() const;

    LUNCHBOX_API Strings getKeys( const std::string& instance ) const;

    LUNCHBOX_API bool containsKey( const std::string& instance,
                                   const std::string& key ) const;

    LUNCHBOX_API const std::string& get( const std::string& instance,
                                         const std::string& key ) const;

    typedef std::map< std::string, std::map< std::string, std::string > > Data;

    LUNCHBOX_API void getData( Data& data );

private:
    detail::Servus* const _impl;
    friend LUNCHBOX_API std::ostream& operator << ( std::ostream&,
                                                    const Servus& );
};

LUNCHBOX_API std::ostream& operator << ( std::ostream&, const Servus& );

LUNCHBOX_API std::ostream& operator << (std::ostream&,const Servus::Interface&);
}

#endif // LUNCHBOX_SERVUS_H