TiA_full_doc/tia__client__impl__base_8h_source.html

00001 /*
00002     This file is part of the TOBI Interface A (TiA) library.
00003
00004     Commercial Usage
00005     Licensees holding valid Graz University of Technology Commercial
00006     licenses may use this file in accordance with the Graz University
00007     of Technology Commercial License Agreement provided with the
00008     Software or, alternatively, in accordance with the terms contained in
00009     a written agreement between you and Graz University of Technology.
00010
00011     --------------------------------------------------
00012
00013     GNU Lesser General Public License Usage
00014     Alternatively, this file may be used under the terms of the GNU Lesser
00015     General Public License version 3.0 as published by the Free Software
00016     Foundation and appearing in the file lgpl.txt included in the
00017     packaging of this file.  Please review the following information to
00018     ensure the GNU General Public License version 3.0 requirements will be
00019     met: http://www.gnu.org/copyleft/lgpl.html.
00020
00021     In case of GNU Lesser General Public License Usage ,the TiA library
00022     is distributed in the hope that it will be useful,
00023     but WITHOUT ANY WARRANTY; without even the implied warranty of
00024     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00025     GNU General Public License for more details.
00026
00027     You should have received a copy of the GNU Lesser General Public License
00028     along with the TiA library. If not, see <http://www.gnu.org/licenses/>.
00029
00030     Copyright 2010 Graz University of Technology
00031     Contact: TiA@tobi-project.org
00032 */
00033
00041 #ifndef TIA_CLIENT_IMPL_BASE_H
00042 #define TIA_CLIENT_IMPL_BASE_H
00043
00044 #include <string>
00045
00046 namespace tia
00047 {
00048 // forward declarations;
00049 class SSConfig;
00050 class DataPacket;
00051
00052 //-----------------------------------------------------------------------------
00058 class TiAClientImplBase
00059 {
00060 public:
00064   TiAClientImplBase(){}
00068   virtual ~TiAClientImplBase(){}
00073   virtual void connect(const std::string& address, short unsigned port) = 0;
00079   virtual bool connected() const = 0;
00084   virtual void disconnect() = 0;
00089   virtual void requestConfig() = 0;
00094   virtual SSConfig config() const = 0;
00099   virtual void startReceiving(bool use_udp_bc) = 0;
00104   virtual bool receiving() const = 0;
00109   virtual void stopReceiving() = 0;
00113   virtual void getDataPacket(DataPacket& packet) = 0;
00117   virtual void setBufferSize(size_t size) = 0;
00118
00122   virtual DataPacket* getEmptyDataPacket() = 0;
00123 };
00124
00125 } // Namespace tobiss
00126
00127 //-----------------------------------------------------------------------------
00128
00129 #endif // TIA_CLIENT_IMPL_BASE_H