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
|
// -*- C++ -*-
// $Id$
// ============================================================================
//
// = LIBRARY
// AMI_Observer
//
// = FILENAME
// Callback_i.h
//
// = DESCRIPTION
// Header file for the Web_Server::Callback implementation.
//
// = AUTHOR
// Ossama Othman <ossama@uci.edu>
//
// ============================================================================
#ifndef CALLBACK_I_H
#define CALLBACK_I_H
#include "ace/FILE_Addr.h"
#include "ace/FILE_IO.h"
#include "Push_Web_ServerS.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
// This is to remove "inherits via dominance" warnings from MSVC.
// MSVC is being a little too paranoid.
#if defined(_MSC_VER)
#if (_MSC_VER >= 1200)
#pragma warning(push)
#endif /* _MSC_VER >= 1200 */
#pragma warning(disable:4250)
#endif /* _MSC_VER */
// Implement the Web_Server::Callback interface.
class Callback_i :
public virtual POA_Web_Server::Callback,
public virtual PortableServer::RefCountServantBase
{
// = TITLE
// Implement the Web_Server::Callback interface.
//
// = DESCRIPTION
// A <Callback> object implements the Observer pattern. It
// simply "watches" while the Content Server pushes chunks of
// data to itself. Once the Content Server pushes the last chunk
// of data, the <Callback> object spawns an external viewer to
// display the pushed data based on the data content type
// returned by the Iterator_Factory::register_callback() method.
//
// Since the server pushes data to the <Callback> object
// asynchronously, and since instances of this <Callback> class
// are registered with the Content Server asynchronously, there
// is no guarantee that the metadata containing the content type
// will arrive before the content of the file. As such, this
// class atomically sets and checks the flags that provide the
// current condition of the metadata and content, in case two
// concurrently running threads attempt to update the state
// contained within a given <Callback> object.
friend class Callback_i_Friend;
// Dummy friend class declaration to quiet down a warning.
public:
Callback_i (int *request_count);
// Constructor
virtual void next_chunk (const Web_Server::Chunk_Type &chunk,
CORBA::Boolean last_chunk,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// This operation returns the next <chunk> of the file starting at
// <offset>. If there are no more bindings, false is returned.
void metadata (const Web_Server::Metadata_Type &metadata);
// Set metadata associated with received data.
private:
~Callback_i (void);
// Destructor must be private to ensure that this object is
// allocated on the heap.
int metadata_received (void);
// Returns one if the metadata was received, and zero otherwise.
int content_received (void);
// Returns one if the entire content was received, and zero
// otherwise.
int get_viewer (char *viewer, size_t length);
// Get the name of the viewer associated with the file being
// retrieved.
int spawn_viewer (void);
// Spawn an external view to display the retrieved file.
private:
void deactivate (CORBA::Environment &ACE_TRY_ENV);
// Deactivate this Callback servant.
private:
ACE_FILE_Addr file_;
// The Addr corresponding to the retrieved file.
ACE_FILE_IO file_io_;
// The object that provides all file related IO operations
// (e.g. read, write, etc).
Web_Server::AMI_CallbackHandler_var ami_handler_;
// Reference to this Reply Handler's self.
Web_Server::Metadata_Type metadata_;
// The metadata associated with the file being retrieved from the
// web server.
int last_chunk_;
// Flag that indicates entire data content has been received.
TAO_SYNCH_MUTEX lock_;
// Lock used to prevent race conditions when checking to see if
// metadata or entire content has been received.
int *request_count_;
// Pointer to external status monitoring variable. The contents (not
// the pointer itself) of the <pending_data> parameter will be
// decremented when file retrieval has completed.
};
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
#pragma warning(pop)
#endif /* _MSC_VER */
#endif /* CALLBACK_I_H */
|
