dali/internal/network/common/automation.h

   1 #ifndef DALI_INTERNAL_ADAPTOR_AUTOMATION_H
   2 #define DALI_INTERNAL_ADAPTOR_AUTOMATION_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21
  22 // EXTERNAL INCLUDES
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/internal/network/common/client-send-data-interface.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 namespace Adaptor
  35 {
  36
  37 /**
  38  * @brief The automation functions allow a way to control Dali via a network socket.
  39  *
  40  * The functions must be called from the event thread only.
  41  *
  42  * Any functions which require a response to be sent back to the network client
  43  * use the ClientSendDataInterface interface.
  44
  45  * E.g.
  46  * Dali network client thread            <---- "dump_scene" from network
  47  * Dali main thread       "json data"    ----->   network
  48  *
  49  */
  50 namespace Automation
  51 {
  52
  53 /**
  54  * @brief Sets properties on an Actor.
  55  * No ClientSendDataInterface required, as no response is sent back
  56  * @param[in] message set property message
  57  */
  58 void SetProperty( const std::string& message );
  59
  60
  61 /**
  62  * @brief Dumps the actor tree to the client
  63  * @param[in] clientId unique network client id
  64  * @param[in] sendData interface to transmit data to the client
  65  */
  66 void DumpScene( unsigned int clientId, ClientSendDataInterface* sendData );
  67
  68
  69 } // namespace Automation
  70
  71 } // namespace Internal
  72
  73 } // namespace Adaptor
  74
  75 } // namespace Dali
  76
  77 #endif