Line data    Source code

       1              : /*
       2              :  * If not stated otherwise in this file or this component's LICENSE file the
       3              :  * following copyright and licenses apply:
       4              :  *
       5              :  * Copyright 2023 Sky UK
       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              : #ifndef FIREBOLT_RIALTO_SERVER_I_CONTROL_CLIENT_SERVER_INTERNAL_H_
      21              : #define FIREBOLT_RIALTO_SERVER_I_CONTROL_CLIENT_SERVER_INTERNAL_H_
      22              : 
      23              : /**
      24              :  * @file IControlClientServerInternal.h
      25              :  *
      26              :  * The definition of the IControlClientServerInternal interface.
      27              :  *
      28              :  * This file comprises the definition of the IControlClientServerInternal abstract
      29              :  * class. This is the API by which a IControl implementation will
      30              :  * pass notifications to its client.
      31              :  */
      32              : 
      33              : #include "IControlClient.h"
      34              : 
      35              : namespace firebolt::rialto::server
      36              : {
      37              : /**
      38              :  * @brief The Rialto control client server internal interface.
      39              :  *
      40              :  * This is server internal Rialto control client abstract base class. It should be
      41              :  * implemented by any object that sends notification about rialto server state to its client
      42              :  *
      43              :  */
      44              : 
      45              : class IControlClientServerInternal : public IControlClient
      46              : {
      47              : public:
      48              :     /**
      49              :      * @brief Virtual destructor
      50              :      */
      51           27 :     virtual ~IControlClientServerInternal() = default;
      52              : 
      53              :     /**
      54              :      * @brief Ping notification for checking system health
      55              :      * The client should perform any health checks then respond with
      56              :      * a call to ack(id) if system healthy
      57              :      *
      58              :      * @param[in] id  : Unique id, should be passed to corresponding ack call
      59              :      */
      60              :     virtual void ping(uint32_t id) = 0;
      61              : };
      62              : } // namespace firebolt::rialto::server
      63              : 
      64              : #endif // FIREBOLT_RIALTO_SERVER_I_CONTROL_CLIENT_SERVER_INTERNAL_H_