Device.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"

namespace gf
{
    class DeviceListener;
    class DeviceSetting;

    class Device
    {
    public:
        virtual GF_UINT8 getAddrType() const = 0;

        virtual tstring getAddress() const = 0;

        virtual tstring getName() const = 0;

        virtual GF_UINT getRssi() const = 0;

        virtual GF_RET_CODE identify(int msec = 1000) = 0;

        virtual DeviceConnectionStatus getConnectionStatus() const = 0;

        virtual GF_RET_CODE setAlias(tstring alias) = 0;

        virtual tstring getAlias() const = 0;

        virtual GF_RET_CODE connect(bool directConn = true) = 0;

        virtual GF_RET_CODE disconnect() = 0;

        virtual GF_RET_CODE cancelConnect() = 0;

        // externsion for new protocol

        virtual gfsPtr<DeviceSetting> getDeviceSetting() = 0;

    protected:
        virtual ~Device() {}
    };

} // namespace gf