rstudio/src/cpp/session/SessionClientEventQueue.cpp at master · aakashdoiphode/rstudio · GitHub

History

215 lines (180 loc) · 5.41 KB

Raw

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

* SessionClientEventQueue.cpp

* Unless you have received this program directly from RStudio pursuant

* to the terms of a commercial license agreement with RStudio, then

* this program is licensed to you under the terms of version 3 of the

* GNU Affero General Public License. This program is distributed WITHOUT

* ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,

* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the

* AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.

#include "SessionClientEventQueue.hpp"

#include "modules/SessionConsole.hpp"

#include <boost/foreach.hpp>

#include <core/BoostThread.hpp>

#include <core/Thread.hpp>

#include <core/json/Json.hpp>

#include <core/StringUtils.hpp>

#include <r/session/RConsoleActions.hpp>

using namespace rstudio::core ;

namespace rstudio {

namespace session {

namespace {

ClientEventQueue* s_pClientEventQueue = NULL;

}

void initializeClientEventQueue()

{

BOOST_ASSERT(s_pClientEventQueue == NULL);

s_pClientEventQueue = new ClientEventQueue();

}

ClientEventQueue& clientEventQueue()

{

return *s_pClientEventQueue;

}

ClientEventQueue::ClientEventQueue()

: pMutex_(new boost::mutex()),

pWaitForEventCondition_(new boost::condition()),

lastEventAddTime_(boost::posix_time::not_a_date_time)

{

}

bool ClientEventQueue::setActiveConsole(const std::string& console)

{

bool changed = false;

LOCK_MUTEX(*pMutex_)

{

if (activeConsole_ != console)

{

// flush events to the previous console

flushPendingConsoleOutput();

// switch to the new one

activeConsole_ = console;

changed = true;

}

END_LOCK_MUTEX

return changed;

}

void ClientEventQueue::add(const ClientEvent& event)

{

LOCK_MUTEX(*pMutex_)

{

// console output is batched up for compactness/efficiency.

if (event.type() == client_events::kConsoleWriteOutput)

{

if (event.data().type() == json::StringType)

pendingConsoleOutput_ += event.data().get_str();

}

else if (event.type() == client_events::kConsoleWriteError &&

event.data().type() == json::StringType)

{

flushPendingConsoleOutput();

enqueueClientOutputEvent(event.type(), event.data().get_str());

}

else

{

// flush existing console output prior to adding an

// action of another type

flushPendingConsoleOutput() ;

// add event to queue

pendingEvents_.push_back(event) ;

}

lastEventAddTime_ = boost::posix_time::microsec_clock::universal_time();

}

END_LOCK_MUTEX

// notify listeners that an event has been added

pWaitForEventCondition_->notify_all();

}

bool ClientEventQueue::hasEvents()

{

LOCK_MUTEX(*pMutex_)

{

return pendingEvents_.size() > 0 || pendingConsoleOutput_.length() > 0;

}

END_LOCK_MUTEX

// keep compiler happy

return false ;

}

void ClientEventQueue::remove(std::vector<ClientEvent>* pEvents)

{

LOCK_MUTEX(*pMutex_)

{

// flush any pending output

flushPendingConsoleOutput();

// copy the events to the caller

pEvents->insert(pEvents->begin(),

pendingEvents_.begin(),

pendingEvents_.end());

// clear pending events

pendingEvents_.clear();

}

END_LOCK_MUTEX

}

void ClientEventQueue::clear()

{

LOCK_MUTEX(*pMutex_)

{

pendingConsoleOutput_.clear();

pendingEvents_.clear();

}

END_LOCK_MUTEX

}

bool ClientEventQueue::waitForEvent(

const boost::posix_time::time_duration& waitDuration)

{

using namespace boost;

try

{

unique_lock<mutex> lock(*pMutex_);

system_time timeoutTime = get_system_time() + waitDuration;

return pWaitForEventCondition_->timed_wait(lock, timeoutTime);

}

catch(const thread_resource_error& e)

{

Error waitError(boost::thread_error::ec_from_exception(e),

ERROR_LOCATION) ;

LOG_ERROR(waitError);

return false ;

}

bool ClientEventQueue::eventAddedSince(const boost::posix_time::ptime& time)

{

LOCK_MUTEX(*pMutex_)

{

if (lastEventAddTime_.is_not_a_date_time())

return false;

else

return lastEventAddTime_ >= time;

}

END_LOCK_MUTEX

// keep compiler happy

return false;

}

void ClientEventQueue::flushPendingConsoleOutput()

{

// NOTE: private helper so no lock required (mutex is not recursive)

if ( !pendingConsoleOutput_.empty() )

{

// If there's more console output than the client can even show, then

// truncate it to the amount that the client can show. Too much output

// can overwhelm the client, causing it to become unresponsive.

int limit = r::session::consoleActions().capacity() + 1;

string_utils::trimLeadingLines(limit, &pendingConsoleOutput_);

enqueueClientOutputEvent(client_events::kConsoleWriteOutput,

pendingConsoleOutput_);

pendingConsoleOutput_.clear() ;

}

void ClientEventQueue::enqueueClientOutputEvent(

int event, const std::string& text)

{

json::Object output;

output[kConsoleText] = text;

output[kConsoleId] = activeConsole_;

pendingEvents_.push_back(ClientEvent(event, output));

}

} // namespace session

} // namespace rstudio

rstudio/src/cpp/session/SessionClientEventQueue.cpp at master · aakashdoiphode/rstudio · GitHub

Expand file tree

Breadcrumbs

SessionClientEventQueue.cpp

Latest commit

History

Breadcrumbs

SessionClientEventQueue.cpp

File metadata and controls