70 lines
1.5 KiB
C++
70 lines
1.5 KiB
C++
/**
|
|
* @file include/ActivMiddleware/ActivBase/Ip/INetworkAffinityHelper.h
|
|
*
|
|
* @brief Header file for the INetworkAffinityHelper interface class.
|
|
*/
|
|
|
|
#if (!defined ACTIV_BASE_I_NETWORK_AFFINITY_HELPER_H)
|
|
#define ACTIV_BASE_I_NETWORK_AFFINITY_HELPER_H
|
|
|
|
#include "ActivMiddleware/ActivBase/External.h"
|
|
|
|
#include "ActivMiddleware/CxxYZ/memory.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
// Forward declarations.
|
|
class NetworkAffinityFilter;
|
|
|
|
//! INetworkAffinityHelper interface class.
|
|
class INetworkAffinityHelper : private Boost::noncopyable
|
|
{
|
|
public:
|
|
//! Destructor.
|
|
ACTIV_BASE_API virtual ~INetworkAffinityHelper() = 0;
|
|
|
|
/**
|
|
* @brief Create network affinity helper.
|
|
*
|
|
* @return The created network affinity helper.
|
|
*/
|
|
ACTIV_BASE_API static CxxYZ::unique_ptr<INetworkAffinityHelper> Create();
|
|
|
|
/**
|
|
* @brief Is supported.
|
|
*
|
|
* @retval true if supported, false otherwise.
|
|
*/
|
|
ACTIV_BASE_API static bool IsSupported();
|
|
|
|
/**
|
|
* @brief Get type.
|
|
*
|
|
* @return A string defining the implementation type.
|
|
*/
|
|
ACTIV_BASE_API virtual String GetType() const = 0;
|
|
|
|
/**
|
|
* @brief Add filter.
|
|
*
|
|
* @param networkAffinityFilter
|
|
*
|
|
* @retval STATUS_CODE_SUCCESS
|
|
* @retval ...
|
|
*/
|
|
ACTIV_BASE_API virtual StatusCode AddFilter(const NetworkAffinityFilter &networkAffinityFilter) = 0;
|
|
|
|
/**
|
|
* @brief Remove filter.
|
|
*
|
|
* @param networkAffinityFilter
|
|
*/
|
|
ACTIV_BASE_API virtual void RemoveFilter(const NetworkAffinityFilter &networkAffinityFilter) = 0;
|
|
};
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_BASE_I_NETWORK_AFFINITY_HELPER_H)
|