Hub.h

Go to the documentation of this file.

/*
 * Copyright 2017, OYMotion Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 */
#pragma once

#include "gfTypes.h"
#include <vector>
#include <functional>

namespace gf
{
    class HubListener;

    class Hub
    {
    public:
        virtual GF_RET_CODE init(GF_UINT8 comPort = 0) = 0;

        virtual GF_RET_CODE deinit() = 0;

        virtual WorkMode getWorkMode() const = 0;

        virtual void setWorkMode(WorkMode newMode) = 0;

        virtual HubState getState() = 0;

        virtual tstring getDescString() const = 0;

        virtual GF_RET_CODE registerListener(const gfwPtr<HubListener>& listener) = 0;

        virtual GF_RET_CODE unRegisterListener(const gfwPtr<HubListener>& listener) = 0;

        virtual GF_RET_CODE startScan(GF_UINT8 rssiThreshold = 200) = 0;

        virtual GF_RET_CODE stopScan() = 0;

        virtual GF_SIZE getNumOfDevices(bool bConnectedOnly = true) const = 0;

        virtual void enumDevices(std::function<bool(SPDEVICE)>& funEnum, bool bConnectedOnly = true) = 0;

        virtual SPDEVICE findDevice(GF_UINT8 addrType, tstring address) = 0;

        virtual GF_RET_CODE run(GF_UINT32 ms, bool once = false) = 0;

    protected:
        Hub() {}
        virtual ~Hub() {}
    };

} // namespace gf