File size: 10,563 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  Author(s):  Peter Kazanzides, Anton Deguet
  Created on: 2007-09-05

  (C) Copyright 2007-2019 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#include <cisstCommon/cmnAssert.h>
#include <cisstMultiTask/mtsMailBox.h>
#include <cisstMultiTask/mtsCallableVoidBase.h>
#include <cisstMultiTask/mtsCallableVoidReturnBase.h>
#include <cisstMultiTask/mtsCallableWriteReturnBase.h>
#include <cisstMultiTask/mtsCommandQueuedVoid.h>
#include <cisstMultiTask/mtsCommandQueuedVoidReturn.h>
#include <cisstMultiTask/mtsCommandQueuedWrite.h>
#include <cisstMultiTask/mtsCommandQueuedWriteReturn.h>


mtsMailBox::mtsMailBox(const std::string & name,
                       size_t size,
                       mtsCallableVoidBase * postCommandQueuedCallable):
    CommandQueue(size, 0),
    Name(name),
    PostCommandQueuedCallable(postCommandQueuedCallable),
    PostCommandDequeuedCommand(0),
    PostCommandReturnDequeuedCommand(0)
{}


mtsMailBox::~mtsMailBox(void)
{}


const std::string & mtsMailBox::GetName(void) const
{
    return this->Name;
}


bool mtsMailBox::Write(mtsCommandBase * command)
{
    bool result;
    result = (CommandQueue.Put(command) != 0);
    if (this->PostCommandQueuedCallable) {
        this->PostCommandQueuedCallable->Execute();
    }
    return result;
}


// return false if nothing to execute; true otherwise.
bool mtsMailBox::ExecuteNext(void)
{
   mtsCommandBase** command = CommandQueue.Peek();

   // test for empty queue
   if (!command) {
       return false;
   }

   mtsCommandQueuedVoid * commandVoid;
   mtsCommandQueuedWriteBase * commandWrite;
   mtsCommandQueuedVoidReturn * commandVoidReturn;
   mtsCommandQueuedWriteReturn * commandWriteReturn;
   mtsCommandQueuedRead * commandRead;
   mtsCommandQueuedQualifiedRead * commandQualifiedRead;

   mtsExecutionResult result;
   mtsGenericObject *resultPointer = 0;
   mtsCommandWriteBase *finishedEvent = 0;

   bool isBlocking = false;
   bool isBlockingReturn = false;
   try {
       if (!(*command)->Returns()) {
           switch ((*command)->NumberOfArguments()) {
           case 0:
               commandVoid = dynamic_cast<mtsCommandQueuedVoid *>(*command);
               CMN_ASSERT(commandVoid);
               isBlocking = (commandVoid->BlockingFlagGet() == MTS_BLOCKING);
               finishedEvent = commandVoid->FinishedEventGet();
               result = commandVoid->GetCallable()->Execute();
               break;
           case 1:
               commandWrite = dynamic_cast<mtsCommandQueuedWriteBase *>(*command);
               if (commandWrite) {
                   isBlocking = (commandWrite->BlockingFlagGet() == MTS_BLOCKING);
                   finishedEvent = commandWrite->FinishedEventGet();
                   try {
                       result = commandWrite->GetActualCommand()->Execute(*(commandWrite->ArgumentPeek()), MTS_NOT_BLOCKING);
                   }
                   catch (...) {
                       commandWrite->ArgumentGet();  // Remove from parameter queue
                       throw;
                   }
                   commandWrite->ArgumentGet();  // Remove from parameter queue
               }
               else {
                   // For the Read command, NumberOfArguments() is 1, and Returns() is false.
                   // But, we will handle a queued Read command the same as a queued Void Return
                   commandRead = dynamic_cast<mtsCommandQueuedRead *>(*command);
                   CMN_ASSERT(commandRead);
                   resultPointer = commandRead->ReturnGet();
                   finishedEvent = commandRead->FinishedEventGet();
                   isBlockingReturn = true;
                   result = commandRead->GetCallable()->Execute(*resultPointer);
               }
               break;
           case 2:
               // For the Qualified Read command, NumberOfArguments() is 2, and Returns() is false.
               // But, we will handle a queued Qualified Read command the same as a queued Write Return.
               commandQualifiedRead = dynamic_cast<mtsCommandQueuedQualifiedRead *>(*command);
               CMN_ASSERT(commandQualifiedRead);
               resultPointer = commandQualifiedRead->ReturnGet();
               finishedEvent = commandQualifiedRead->FinishedEventGet();
               isBlockingReturn = true;
               try {
                   result = commandQualifiedRead->GetCallable()->Execute( *(commandQualifiedRead->ArgumentPeek()), *resultPointer);
               }
               catch (...) {
                   commandQualifiedRead->ArgumentGet();  // Remove from parameter queue
                   throw;
               }
               commandQualifiedRead->ArgumentGet();  // Remove from parameter queue
               break;
           default:
               CMN_LOG_RUN_ERROR << "Class mtsMailBox: Invalid parameter in ExecuteNext" << std::endl;
               return false;
           }
       } else {
           switch ((*command)->NumberOfArguments()) {
           case 0:
               commandVoidReturn = dynamic_cast<mtsCommandQueuedVoidReturn *>(*command);
               CMN_ASSERT(commandVoidReturn);
               resultPointer = commandVoidReturn->ReturnGet();
               finishedEvent = commandVoidReturn->FinishedEventGet();
               isBlockingReturn = true;
               result = commandVoidReturn->GetCallable()->Execute(*resultPointer);
               break;
           case 1:
               commandWriteReturn = dynamic_cast<mtsCommandQueuedWriteReturn *>(*command);
               CMN_ASSERT(commandWriteReturn);
               resultPointer = commandWriteReturn->ReturnGet();
               finishedEvent = commandWriteReturn->FinishedEventGet();
               isBlockingReturn = true;
               try {
                   result = commandWriteReturn->GetCallable()->Execute( *(commandWriteReturn->ArgumentPeek()), *resultPointer);
               }
               catch (...) {
                   commandWriteReturn->ArgumentGet();  // Remove from parameter queue
                   throw;
               }
               commandWriteReturn->ArgumentGet();  // Remove from parameter queue
               break;
           default:
               CMN_LOG_RUN_ERROR << "Class mtsMailBox: Invalid parameter in ExecuteNext" << std::endl;
               return false;
           }
       }
   }
   catch (std::exception & exceptionCaught) {
       CMN_LOG_RUN_WARNING << "mtsMailbox \"" << GetName() << "\": ExecuteNext for command \"" << (*command)->GetName()
                           << "\" caught exception \"" << exceptionCaught.what() << "\"" << std::endl;
       CommandQueue.Get();  // Remove command from mailbox queue
       if (resultPointer || isBlocking)
          TriggerFinishedEventIfNeeded((*command)->GetName(), finishedEvent, resultPointer, result);
       throw;
   }
   catch (...) {
       CMN_LOG_RUN_WARNING << "mtsMailbox \"" << GetName() << "\": ExecuteNext for command \"" << (*command)->GetName()
                           << "\" caught exception, blocking = " << isBlocking << std::endl;
       CommandQueue.Get();  // Remove command from mailbox queue
       if (resultPointer || isBlocking)
           TriggerFinishedEventIfNeeded((*command)->GetName(), finishedEvent, resultPointer, result);
       throw;
   }
   if (!result.IsOK()) {
       CMN_LOG_RUN_WARNING << "mtsMailbox \"" << GetName() << "\": ExecuteNext for command \"" << (*command)->GetName()
                           << "\" failed, execution result is \"" << result << "\"" << std::endl;
   }
   CommandQueue.Get();  // Remove command from mailbox queue
   if (resultPointer || isBlocking)
       TriggerFinishedEventIfNeeded((*command)->GetName(), finishedEvent, resultPointer, result);
   return true;
}


void mtsMailBox::TriggerFinishedEventIfNeeded(const std::string &commandName, mtsCommandWriteBase *finishedEvent,
                                              mtsGenericObject *resultPointer, const mtsExecutionResult &result) const
{
   if (finishedEvent) {
       mtsExecutionResult evt_result(mtsExecutionResult::COMMAND_SUCCEEDED);
       if (resultPointer) {
           if (resultPointer->Valid() != result.IsOK()) {
               CMN_LOG_RUN_WARNING << "TriggerFinishedEventIfNeeded: result valid = " << resultPointer->Valid()
                                   << ", result OK = " << result.IsOK()
                                   << ", msg = " << mtsExecutionResult::ToString(result.Value())
                                   << ", msg type = " << resultPointer->Services()->GetName()
                                   << ", command name = " << commandName << std::endl;
           }
           resultPointer->SetValid(result.IsOK());  // Set data valid flag based on execution result
           evt_result = finishedEvent->Execute(*resultPointer, MTS_NOT_BLOCKING);
       }
       else {
           evt_result = finishedEvent->Execute(mtsExecutionResultProxy(result), MTS_NOT_BLOCKING);
       }
       if (!evt_result.IsOK()) {
           CMN_LOG_RUN_ERROR << "mtsMailbox: Failed to execute FinishedEvent for command " << commandName
                             << ", result = " << evt_result << std::endl;
       }
   }
}

void mtsMailBox::SetSize(size_t size)
{
    if (CommandQueue.GetSize() != size) {
        CommandQueue.SetSize(size, 0); // array of null pointers
    }
}


bool mtsMailBox::IsEmpty(void) const
{
    return CommandQueue.IsEmpty();
}


bool mtsMailBox::IsFull(void) const
{
    return CommandQueue.IsFull();
}

size_t mtsMailBox::GetAvailable(void) const
{
    return CommandQueue.GetAvailable();
}

void mtsMailBox::SetPostCommandDequeuedCommand(mtsCommandVoid * command)
{
    this->PostCommandDequeuedCommand = command;
}

mtsCommandVoid *mtsMailBox::GetPostCommandDequeuedCommand(void) const
{
    return this->PostCommandDequeuedCommand;
}

void mtsMailBox::SetPostCommandReturnDequeuedCommand(mtsCommandVoid * command)
{
    this->PostCommandReturnDequeuedCommand = command;
}

mtsCommandVoid *mtsMailBox::GetPostCommandReturnDequeuedCommand(void) const
{
    return this->PostCommandReturnDequeuedCommand;
}