RpcBrokenPipeException.hpp

// Copyright 2025 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @file RpcBrokenPipeException.hpp
 */

#ifndef FASTDDS_DDS_RPC_EXCEPTIONS__RPCBROKENPIPEEXCEPTION_HPP
#define FASTDDS_DDS_RPC_EXCEPTIONS__RPCBROKENPIPEEXCEPTION_HPP

#include <fastdds/fastdds_dll.hpp>
#include <fastdds/dds/rpc/exceptions/RpcException.hpp>

namespace eprosima {
namespace fastdds {
namespace dds {
namespace rpc {

/**
 * Exception thrown by the RPC API when the communication with the remote endpoint breaks.
 */
class FASTDDS_EXPORTED_API RpcBrokenPipeException : public RpcException
{

public:

    /**
     * Constructor.
     */
    RpcBrokenPipeException(
            bool local_is_server)
        : RpcException(local_is_server ? "Communication lost with the client" : "Communication lost with the server")
    {
    }

    /**
     * Copy constructor.
     */
    RpcBrokenPipeException(
            const RpcBrokenPipeException& other) noexcept = default;

    /**
     * Copy assignment.
     */
    RpcBrokenPipeException& operator =(
            const RpcBrokenPipeException& other) noexcept = default;

    /**
     * Destructor.
     */
    virtual ~RpcBrokenPipeException() noexcept = default;

};

}  // namespace rpc
}  // namespace dds
}  // namespace fastdds
}  // namespace eprosima

#endif  // FASTDDS_DDS_RPC_EXCEPTIONS__RPCBROKENPIPEEXCEPTION_HPP