1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
/*****************************************************************************
*
* Copyright (c) 2000 - 2010, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-400124
* All rights reserved.
*
* This file is part of VisIt. For details, see https://visit.llnl.gov/. The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the disclaimer (as noted below) in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the LLNS/LLNL nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/
#ifndef VISIT_RPC_H
#define VISIT_RPC_H
#include <state_exports.h>
#include <AttributeSubject.h>
#include <string>
// ****************************************************************************
// Modifications:
//
// Hank Childs, Thu Feb 8 10:22:45 PST 2007
// Make sure that MaxStageNum is never less than CurStageNum.
//
// Brad Whitlock, Fri Dec 7 11:57:01 PST 2007
// Added TypeName overrides.
//
// ****************************************************************************
class Xfer;
//-----------------------------------------------------------------------------
// Class: VisItRPC
//-----------------------------------------------------------------------------
class STATE_API VisItRPC : public AttributeSubject
{
public:
// enum: status
enum status
{
none,
incomplete,
complete,
error,
warning,
abort
};
// Class: RPCReply
class STATE_API RPCReply : public AttributeSubject
{
public:
RPCReply(int s, AttributeSubject *d);
~RPCReply();
virtual void SelectAll();
void SetStatus(int s);
int GetStatus() const;
void SetMessage(const std::string &msg);
const std::string &Message() const;
void SetExceptionType(const std::string &type);
const std::string &GetExceptionType() const;
void SetData(AttributeSubject *d);
AttributeSubject *GetData();
void SetRPCName(const std::string &);
virtual const std::string TypeName() const;
private:
int status;
std::string message;
std::string type;
AttributeSubject *data;
// non-transmissible
std::string rpcName;
};
public:
VisItRPC(const char *, int s=none, AttributeSubject *d=NULL);
virtual ~VisItRPC();
int GetStatus() const;
const std::string &Message() const;
const std::string &GetExceptionType() const;
RPCReply *GetReply();
virtual void SetXfer(Xfer *x);
void SendAbort();
void SendError();
void SendError(const std::string &msg);
void SendError(const std::string &msg, const std::string &etype);
void SendWarning(const std::string &msg);
virtual const std::string TypeName() const
{
return "VisItRPC";
}
protected:
virtual void Execute() = 0;
void SendReply(int s, AttributeSubject *d);
void RecvReply();
RPCReply reply;
Xfer *xfer;
};
//-----------------------------------------------------------------------------
// Class: NonBlockingRPC
//-----------------------------------------------------------------------------
class STATE_API NonBlockingRPC : public VisItRPC
{
public:
// Class: CompletionData
class STATE_API CompletionData : public AttributeSubject
{
private:
int percent;
int replyLen;
int curStageNum;
int maxStageNum;
std::string curStageName;
AttributeSubject *replyData;
public:
CompletionData() : AttributeSubject("iiiisa"), percent(0),
curStageNum(0), maxStageNum(0), replyData(NULL){ };
virtual ~CompletionData() { };
void SetPercent(int p) { percent=p; Select(0,&percent); };
int GetPercent() const { return percent; };
void SetReplyLen(int l) { replyLen=l; Select(1,&replyLen); };
int GetReplyLen() const { return replyLen; };
void SetCurStageNum(int n) { curStageNum=n; Select(2,&curStageNum); };
void SetCurStageNumWithoutSending(int n) { curStageNum=n; };
int GetCurStageNum() const { return curStageNum; };
void SetMaxStageNum(int n) { maxStageNum=n; Select(3,&maxStageNum); };
int GetMaxStageNum() const { return (maxStageNum > curStageNum ?
maxStageNum : curStageNum+1); };
void SetCurStageName(const std::string &s)
{ curStageName=s; Select(4,&curStageName);};
std::string GetCurStageName() const
{ return curStageName; };
void SetReplyData(AttributeSubject *rd)
{ replyData = rd; if(replyData) Select(5,replyData); };
AttributeSubject *GetReplyData() const { return replyData; };
void SelectAll()
{
Select(0,&percent);
Select(1,&replyLen);
Select(2,&curStageNum);
Select(3,&maxStageNum);
Select(4,&curStageName);
Select(5,replyData);
};
virtual const std::string TypeName() const
{
return "NonBlockingRPC::CompletionData";
}
};
public:
NonBlockingRPC(const char *fmt, AttributeSubject *d = NULL);
virtual ~NonBlockingRPC();
int GetPercent() const;
int GetReplyLen() const;
int GetCurStageNum() const;
int GetMaxStageNum() const;
std::string GetCurStageName() const;
AttributeSubject *GetReplyData() const;
void SendMaxStages(int n);
void SendStage(int n, const std::string &s);
void SendPercent(int p);
void SendStatus(int percent, int curStage, const std::string &curStageName,
int maxStages);
void SendReply(int l);
void SendReply(AttributeSubject *rd=NULL);
void SetCurStageNum(int n) { completion.SetCurStageNumWithoutSending(n); };
void RecvReply();
virtual const std::string TypeName() const
{
return "NonBlockingRPC";
}
protected:
virtual void Execute();
private:
CompletionData completion;
};
//-----------------------------------------------------------------------------
// Class: BlockingRPC
//-----------------------------------------------------------------------------
class STATE_API BlockingRPC : public VisItRPC
{
public:
BlockingRPC(const char *fmt, AttributeSubject *d=NULL);
virtual ~BlockingRPC();
void SendReply(AttributeSubject *d=NULL);
virtual const std::string TypeName() const
{
return "BlockingRPC";
}
protected:
virtual void Execute();
};
#endif
|