Files
externals/linux/include/ActivMiddleware/ActivBase/Linux/SfcAffinityHelper.h
T

110 lines
2.8 KiB
C++

/**
* @file include/ActivMiddleware/ActivBase/Linux/SfcAffinityHelper.h
*
* @brief Header file for the SfcAffinityHelper class.
*/
#if (!defined ACTIV_BASE_LINUX_SFC_AFFINITY_HELPER_H)
#define ACTIV_BASE_LINUX_SFC_AFFINITY_HELPER_H
#include "ActivMiddleware/ActivBase/External.h"
#include "../Ip/INetworkAffinityHelper.h"
#include "ActivMiddleware/ActivBase/Ip/IpManager.h"
#include "ActivMiddleware/Misc/ScopedHelper.h"
#include <list>
#include <set>
#include <vector>
//! Activ namespace.
namespace Activ
{
// Forward declarations.
class IpAddress;
class NetworkAffinityFilter;
//! Sfc affinity helper class.
class SfcAffinityHelper : public INetworkAffinityHelper
{
public:
/**
* @brief Default constructor.
*
* @throw StatusCodeException
*/
ACTIV_BASE_API SfcAffinityHelper();
//! Destructor.
ACTIV_BASE_API virtual ~SfcAffinityHelper() ACTIV_OVERRIDE;
//! Is sfc affinity driver available.
ACTIV_BASE_API static bool IsAvailable();
//! Get interface info list.
ACTIV_BASE_API const IpManager::InterfaceInfoList &GetInterfaceInfoList() const;
// INetworkAffinityHelper interface.
ACTIV_BASE_API virtual String GetType() const ACTIV_OVERRIDE;
ACTIV_BASE_API virtual StatusCode AddFilter(const NetworkAffinityFilter &networkAffinityFilter) ACTIV_OVERRIDE;
ACTIV_BASE_API virtual void RemoveFilter(const NetworkAffinityFilter &networkAffinityFilter) ACTIV_OVERRIDE;
/**
* @brief Is sfc interface.
*
* @param interfaceInfo
*
* @retval Boolean
*/
ACTIV_BASE_API static bool IsSfcInterface(const IpManager::InterfaceInfo &interfaceInfo);
/**
* @brief Get active filters.
*
* @param interfaceInfo
* @param filterList
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
ACTIV_BASE_API static StatusCode GetActiveFilters(const IpManager::InterfaceInfo &interfaceInfo,
std::vector<String> &filterList);
private:
/**
* @brief Find interface.
*
* @param interfaceIpAddress
* @param pInterfaceInfo the found interface info if successful.
*/
void FindInterface(const IpAddress &interfaceIpAddress, IpManager::InterfaceInfo *&pInterfaceInfo);
/**
* @brief Add filter.
*
* @param interfaceInfo
* @param networkAffinityFilter
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
StatusCode AddFilter(IpManager::InterfaceInfo &interfaceInfo, const NetworkAffinityFilter &networkAffinityFilter);
/**
* @brief Remove filter.
*
* @param interfaceInfo
* @param networkAffinityFilter
*/
void RemoveFilter(IpManager::InterfaceInfo &interfaceInfo, const NetworkAffinityFilter &networkAffinityFilter);
ScopedFd m_sfcAffinityFd; ///< Sfc affinity file descriptor.
IpManager::InterfaceInfoList m_interfaceInfoList; ///< List of interface info for sfc interfaces this object is aware of.
};
} // namespace Activ
#endif // (!defined ACTIV_BASE_LINUX_SFC_AFFINITY_HELPER_H)