/home/breidi/Dropbox/libtia/include/tia/tia_client.h

Go to the documentation of this file.

/*
    This file is part of the TOBI Interface A (TiA) library.

    Commercial Usage
    Licensees holding valid Graz University of Technology Commercial
    licenses may use this file in accordance with the Graz University
    of Technology Commercial License Agreement provided with the
    Software or, alternatively, in accordance with the terms contained in
    a written agreement between you and Graz University of Technology.

    --------------------------------------------------

    GNU Lesser General Public License Usage
    Alternatively, this file may be used under the terms of the GNU Lesser
    General Public License version 3.0 as published by the Free Software
    Foundation and appearing in the file lgpl.txt included in the
    packaging of this file.  Please review the following information to
    ensure the GNU General Public License version 3.0 requirements will be
    met: http://www.gnu.org/copyleft/lgpl.html.

    In case of GNU Lesser General Public License Usage ,the TiA 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 General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with the TiA library. If not, see <http://www.gnu.org/licenses/>.

    Copyright 2010 Graz University of Technology
    Contact: TiA@tobi-project.org
*/

#ifndef TIA_CLIENT_H
#define TIA_CLIENT_H

// STL
#include <string>

#ifndef DECL_EXPORT
  #define DECL_EXPORT
#endif

namespace tia
{
// forward declarations
class DataPacket;
class TiAClientImplBase;
class SSConfig;

class DECL_EXPORT TiAClient
{
public:
  TiAClient( bool use_new_tia);
  virtual ~TiAClient();
  virtual void connect(const std::string& address, short unsigned port);

  virtual bool connected() const;

  virtual void disconnect();

  virtual void requestConfig();
  virtual SSConfig config() const;
  virtual void startReceiving(bool use_udp_bc);
  virtual bool receiving() const;
  virtual void stopReceiving();
  virtual DataPacket* getEmptyDataPacket();

  virtual void getDataPacket(DataPacket& packet);
  virtual void setBufferSize(size_t size);

protected:
  TiAClientImplBase* impl_; 
};

} // Namespace tobiss

//-----------------------------------------------------------------------------

#endif // TIA_CLIENT_H