/home/tobi/workspace/solarpowerlog/src/Connections/interfaces/IConnect.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 solarpowerlog
 Copyright (C) 2009  Tobias Frost

 This file is part of solarpowerlog.

 Solarpowerlog is free software; However, it is dual-licenced
 as described in the file "COPYING".

 For this file (IConnect.h), the license terms are:

 You can redistribute it and/or  modify it under the terms of the GNU Lesser
 General Public License (LGPL) as published by the Free Software Foundation;
 either version 3 of the License, or (at your option) any later version.

 This program 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 Library General Public
 License along with this proramm; if not, see
 <http://www.gnu.org/licenses/>.
 ----------------------------------------------------------------------------
 */

#ifndef ICONNECT_H_
#define ICONNECT_H_

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <string>

#include "configuration/ILogger.h"
#include <boost/thread.hpp>
#include "patterns/ICommand.h"
#include <errno.h>

using namespace std;

// USED ICOMMAND TOKENS
#define ICONN_TOKEN_RECEIVE_STRING "ICON_RECEIVE_STRING"

#define ICONN_TOKEN_SEND_STRING    "ICON_SEND_STRING"

#define ICONN_TOKEN_TIMEOUT "ICON_TIMEOUT"

#define ICONN_TOKEN_INTERBYTETIMEOUT "ICON_INTERBYTE_TIMEOUT"

#warning docs outdated!

class IConnect
{
public:
     IConnect(const string &configurationname);

     virtual void SetupLogger(const string& parentlogger, const string &spec =
               "Comms");

     virtual ~IConnect();


     virtual bool Connect(ICommand *callback = NULL) = 0;

     virtual bool Disconnect(ICommand *callback = NULL) = 0;

#warning depreciate synchronous interface
     // private:
     virtual bool Send(const char *tosend, unsigned int len, ICommand *callback =
               NULL) = 0;

     virtual bool Send(const string& tosend, ICommand *callback = NULL)
     {
          return Send(tosend.c_str(), tosend.length(), callback);
     }

     // virtual bool Receive( string &wheretoplace, ICommand *cmd = NULL ) = 0;

     virtual bool Receive(ICommand *cmd) = 0;

public:

     virtual bool CheckConfig(void) = 0;

     virtual bool IsConnected(void)
     {
          return true;
     }

protected:
     string ConfigurationPath;

     ILogger logger;


     boost::thread workerthread;

     boost::recursive_mutex mutex;

     virtual void _main(void)
     {
          mutex.lock();
          _thread_is_running = false;
          mutex.unlock();
     }

     virtual void StartWorkerThread(void);

     virtual bool IsTermRequested(void);

     virtual bool IsThreadRunning(void);

private:
     bool _thread_is_running;

     bool _thread_term_request;

};

#endif /* ICONNECT_H_ */