QosStyle.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_QOSSTYLE_H
#define YARP_OS_QOSSTYLE_H
 
#include <yarp/os/api.h>
#include <yarp/conf/numeric.h>
 
#include <string>
 
namespace yarp::os {
 
class YARP_os_API QosStyle
{
public:
    enum PacketPriorityLevel
    {
        PacketPriorityInvalid = -1,
        PacketPriorityNormal = 0,
        PacketPriorityLow = 10,
        PacketPriorityHigh = 36,
        PacketPriorityCritical = 44,
        PacketPriorityUndefined = 0x7FFF
    };
 
 
    enum PacketPriorityDSCP
    {
        DSCP_Invalid = -1,
        DSCP_CS0 = 0,
        DSCP_CS1 = 8,
        DSCP_CS2 = 16,
        DSCP_CS3 = 24,
        DSCP_CS4 = 32,
        DSCP_CS5 = 40,
        DSCP_CS6 = 48,
        DSCP_CS7 = 56,
        DSCP_AF11 = 10,
        DSCP_AF12 = 12,
        DSCP_AF13 = 14,
        DSCP_AF21 = 18,
        DSCP_AF22 = 20,
        DSCP_AF23 = 22,
        DSCP_AF31 = 26,
        DSCP_AF32 = 28,
        DSCP_AF33 = 30,
        DSCP_AF41 = 34,
        DSCP_AF42 = 36,
        DSCP_AF43 = 38,
        DSCP_VA = 44,
        DSCP_EF = 46,
        DSCP_Undefined = 0x7FFF
    };
 
 
    explicit QosStyle();
 
 
    void setPacketPriorityByDscp(PacketPriorityDSCP dscp);
 
 
    void setPacketPriorityByLevel(PacketPriorityLevel level);
 
 
    void setPacketPrioritybyTOS(int tos)
    {
        packetPriority = tos;
    }
 
 
    bool setPacketPriority(const std::string& priority);
 
 
    void setThreadPriority(int priority)
    {
        threadPriority = priority;
    }
 
 
    void setThreadPolicy(int policy)
    {
        threadPolicy = policy;
    }
 
 
    int getPacketPriorityAsTOS() const
    {
        return packetPriority;
    }
 
 
    PacketPriorityDSCP getPacketPriorityAsDSCP() const;
 
 
    PacketPriorityLevel getPacketPriorityAsLevel() const;
 
 
    int getThreadPriority() const
    {
        return threadPriority;
    }
 
 
    int getThreadPolicy() const
    {
        return threadPolicy;
    }
 
 
    static PacketPriorityDSCP getDSCPByVocab(yarp::conf::vocab32_t vocab);
 
 
    static PacketPriorityLevel getLevelByVocab(yarp::conf::vocab32_t vocab);
 
 
private:
    int threadPriority;
    int threadPolicy;
    int packetPriority;
};
 
} // namespace yarp::os
 
#endif // YARP_OS_QOSSTYLE_H