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_HEARTBEAT_PROCEDURE_H_
      21              : #define FIREBOLT_RIALTO_SERVER_I_HEARTBEAT_PROCEDURE_H_
      22              : 
      23              : /**
      24              :  * @file IHeartbeatHandler.h
      25              :  *
      26              :  * The definition of the IHeartbeatProcedure interface.
      27              :  *
      28              :  * This interface defines the ping/ack procedure sent for each client.
      29              :  *
      30              :  */
      31              : 
      32              : #include "IAckSender.h"
      33              : #include "IHeartbeatHandler.h"
      34              : #include <memory>
      35              : 
      36              : namespace firebolt::rialto::server
      37              : {
      38              : class IHeartbeatProcedure;
      39              : class IHeartbeatProcedureFactory
      40              : {
      41              : public:
      42           32 :     virtual ~IHeartbeatProcedureFactory() = default;
      43              : 
      44              :     static std::unique_ptr<IHeartbeatProcedureFactory> createFactory();
      45              :     virtual std::shared_ptr<IHeartbeatProcedure> createHeartbeatProcedure(const std::shared_ptr<IAckSender> &ackSender,
      46              :                                                                           std::int32_t pingId) const = 0;
      47              : };
      48              : 
      49              : class IHeartbeatProcedure
      50              : {
      51              : public:
      52          294 :     virtual ~IHeartbeatProcedure() = default;
      53              :     virtual std::unique_ptr<IHeartbeatHandler> createHandler() = 0;
      54              : };
      55              : } // namespace firebolt::rialto::server
      56              : 
      57              : #endif // FIREBOLT_RIALTO_SERVER_I_HEARTBEAT_PROCEDURE_H_