Show RPCOutCall.h syntax highlighted
/**
* @file RPCOutCall.h
* @brief represents a suspended thread waiting for the response from an outgoing call
* @author SBW Development Group <sysbio-team@caltech.edu>
*
* Organization: Caltech ERATO Kitano Systems Biology Project
*
* Created: @date 18th June 2001
* $Id: RPCOutCall.h,v 1.1 2004/06/17 20:15:20 fbergmann Exp $
* $Source: /cvsroot/jdesigner/C++Broker/include/SBW/RPCOutCall.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):
**
*/// RPCOutCall.h: interface for the RPCOutCall class.
//
//////////////////////////////////////////////////////////////////////
#if !defined(AFX_RPCOUTCALL_H__BDC9E857_9758_4759_9CEC_312B01F6E2BD__INCLUDED_)
#define AFX_RPCOUTCALL_H__BDC9E857_9758_4759_9CEC_312B01F6E2BD__INCLUDED_
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
#include "portableOS.h"
#include "DataBlockReaderClass.h"
namespace SystemsBiologyWorkbench
{
/// represents an outgoing call to another module
class RPCOutCall
{
public:
/// create a object to represent an outgoing call.
RPCOutCall() : event("out call") {}
void onBrokerShutdown();
void onOtherModuleInstanceShutdown(Integer otherModuleId);
void processReply(DataBlockReader reader, bool isException);
DataBlockReader waitForReply(Integer moduleId);
private:
/// different outcomes of this call.
enum EventType
{
NormalReplyEvent, /**< conventional response */
NormalExceptionEvent, /**< normal exception response */
BrokerDisconnectEvent, /**< this process disconnected from the broker */
ModuleDisconnectEvent /**< the called module disconnect4ed from the broker */
};
void onEvent(EventType event);
/// outcome of this call
EventType eventType ;
/// call message
DataBlockReader reader ;
/// numeric module identifier for called module
Integer moduleId ;
/** event that signals when an outcome has occurred
* @see EventType
*/
SBWOSEvent event ;
};
} // SystemsBiologyWorkbench
#endif // !defined(AFX_RPCOUTCALL_H__BDC9E857_9758_4759_9CEC_312B01F6E2BD__INCLUDED_)
See more files for this project here