Show SBWModuleRPC.h syntax highlighted
/**
* @file SBWModuleRPC.h
* @brief lowlevel socket management specific to a module instance (as opposed to the broker)
* @author SBW Development Group <sysbio-team@caltech.edu>
*
* Organization: Caltech ERATO Kitano Systems Biology Project
*
* Created: @date 18th June 2001
* $Id: SBWModuleRPC.h,v 1.3 2005/04/01 19:27:52 fbergmann Exp $
* $Source: /cvsroot/jdesigner/C++Broker/include/SBW/SBWModuleRPC.h,v $
*/
/*
** Copyright 2001 California Institute of Technology and
** Japan Science and Technology Corporation.
**
** This library is free software; you can redistribute it and/or modify it
** under the terms of the GNU Lesser General Public License as published
** by the Free Software Foundation; either version 2.1 of the License, or
** any later version.
**
** This 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. The software and
** documentation provided hereunder is on an "as is" basis, and the
** California Institute of Technology and Japan Science and Technology
** Corporation have no obligations to provide maintenance, support,
** updates, enhancements or modifications. In no event shall the
** California Institute of Technology or the Japan Science and Technology
** Corporation be liable to any party for direct, indirect, special,
** incidental or consequential damages, including lost profits, arising
** out of the use of this software and its documentation, even if the
** California Institute of Technology and/or Japan Science and Technology
** Corporation have been advised of the possibility of such damage. See
** the GNU Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with this library; if not, write to the Free Software Foundation,
** Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
**
** The original code contained here was initially developed by:
**
** Andrew Finney, Herbert Sauro, Michael Hucka, Hamid Bolouri
** The Systems Biology Workbench Development Group
** ERATO Kitano Systems Biology Project
** Control and Dynamical Systems, MC 107-81
** California Institute of Technology
** Pasadena, CA, 91125, USA
**
** http://www.cds.caltech.edu/erato
** mailto:sysbio-team@caltech.edu
**
** Contributor(s):
**
*/
/// MSVC generated include loop block
#if !defined(AFX_SBWMODULERPC_H__99E3B76D_3215_447D_9EC8_B49B7C3D1066__INCLUDED_)
#define AFX_SBWMODULERPC_H__99E3B76D_3215_447D_9EC8_B49B7C3D1066__INCLUDED_
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include "portableOS.h"
#include "SBWRPC.h"
#include "SBWListener.h"
namespace SystemsBiologyWorkbench
{
/// lowlevel socket management specific to a module instance (as opposed to the broker)
class SBWModuleRPC : public SBWRPC, private SBWThread
{
public:
SBW_API SBWModuleRPC(SBWRPCListener *);
SBW_API ~SBWModuleRPC();
SBW_API void connect(const char *moduleIdentificationString, const char *hostname = "");
SBW_API void disconnect();
SBW_API void signalDisconnect();
SBW_API bool isConnected();
SBW_API void waitForDisconnect();
SBW_API static bool fileExists(const char *path);
bool connectToBroker(const char *moduleName, const char *hostname, int port);
protected :
Integer getModuleId();
SBW_API void transmitExternalOnly(Integer destinationModuleId, unsigned char *message, Integer length);
private :
SBW_API void run();
int startBroker();
void connectMessageStreams(const char *moduleName);
SBWOSSocket *socket;
/// state of connection to broker.
enum State
{
Disconnected, /**< not connected */
Connecting, /**< in process of creating connection */
Connected,
Disconnecting /**< in process of disconnecting */
};
/// current state of connection
State state;
/// mutex that controls ensures that conncurrent transmits over the socket don't occur.
SBWOSMutex transmitMutex ;
/// the numeric module instance identifier for this module instance.
Integer moduleId ;
};
} // SystemsBiologyWorkbench
#endif // !defined(AFX_SBWMODULERPC_H__99E3B76D_3215_447D_9EC8_B49B7C3D1066__INCLUDED_)
See more files for this project here