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
|
/*****************************************************************************
*
* 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 XFER_H
#define XFER_H
#include <state_exports.h>
#include <SimpleObserver.h>
#include <BufferConnection.h>
#include <vector>
class AttributeSubject;
class Connection;
class VisItRPC;
// ****************************************************************************
// Class: Xfer
//
// Purpose:
// Observes multiple AttributeSubject objects. This class is
// responsible for writing AttributeSubject objects onto a Connection.
//
// Programmer: Brad Whitlock
// Creation: Mon Jun 5 14:43:41 PST 2000
//
// Modifications:
// Brad Whitlock, Thu Aug 31 15:26:28 PST 2000
// Added SubjectRemoved.
//
// Jeremy Meredith, Tue Jul 3 15:02:57 PDT 2001
// Added ReadPendingMessages and SendInterruption.
// Added buffered input.
//
// Brad Whitlock, Fri Mar 22 16:47:23 PST 2002
// Added a debugging function called ListObjects.
//
// Brad Whitlock, Thu Feb 27 10:57:26 PDT 2003
// Added support for special opcodes, which are opcodes that the user
// can inject into the command stream to cause immediate effects.
//
// Brad Whitlock, Thu Apr 14 16:37:24 PST 2005
// Added a method to give access to the buffered input so we can store
// objects directly in it.
//
// Brad Whitlock, Fri Dec 7 17:01:29 PST 2007
// Added methods to get the i'th state object in the Xfer.
//
// ****************************************************************************
class STATE_API Xfer : public SimpleObserver
{
public:
Xfer();
virtual ~Xfer();
virtual void Update(Subject *);
virtual void SubjectRemoved(Subject *);
void Add(AttributeSubject *);
void Add(VisItRPC *);
void Remove(AttributeSubject *);
void SetInputConnection(Connection *);
void SetOutputConnection(Connection *);
Connection *GetInputConnection() const;
Connection *GetOutputConnection() const;
Connection *GetBufferedInputConnection();
virtual void Process();
virtual bool ReadPendingMessages();
virtual void SendInterruption();
int CreateNewSpecialOpcode();
void SendSpecialOpcode(int opcode);
void SetupSpecialOpcodeHandler(void (*cb)(int, void *), void *data);
void ListObjects();
// These should rarely need to be used.
const AttributeSubject *GetSubject(int) const;
int GetNumSubjects() const;
protected:
bool ReadHeader();
int GetNextGuido();
protected:
std::vector<AttributeSubject *> subjectList;
Connection *input, *output;
BufferConnection bufferedInput;
void (*specialOpcodeCallback)(int, void *);
void *specialOpcodeCallbackData;
// These deal with the input connection.
int opcode, length;
bool haveStoredHeader;
// global unique identifier for object (guido)
int nextGuido;
int nextSpecialOpcode;
};
#endif
|
