modularization/thirdpartylib/FastRTPS/include/fastdds/rtps/builtin/discovery/participant/timedevent/DSClientEvent.h

// Copyright 2019 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 DSClientEvent.h
 *
 */

#ifndef _FASTDDS_RTPS_DSCLIENTEVENT_H_
#define _FASTDDS_RTPS_DSCLIENTEVENT_H_
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC

#include <fastdds/rtps/resources/TimedEvent.h>

namespace eprosima {
namespace fastrtps{
namespace rtps {

class PDPClient;

/**
 * Class DSClientEvent, TimedEvent used to synchronize discover-server clients
 *@ingroup DISCOVERY_MODULE
 */
class DSClientEvent : public TimedEvent {
public:

    /**
     * Constructor.
     * @param p_PDP Pointer to the PDPClient.
     * @param interval Interval in ms.
     */
    DSClientEvent(PDPClient* p_PDP,
            double interval);
    ~DSClientEvent();

    /**
    * Method invoked when the event occurs.
    * This temporal event:
        + resends the client RTPSParticipantProxyData to all remote servers.
        + matches the EDP endpoints when the servers are all aware of this client existence
    */
    bool event();

    //!Pointer to the PDPServer object.
    PDPClient* mp_PDP;
};
}
} /* namespace rtps */
} /* namespace eprosima */
#endif
#endif /* _FASTDDS_RTPS_DSCLIENTEVENT_H_ */