htb.hpp

Go to the documentation of this file.

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.

#ifndef __LINUX_ROUTING_QUEUEING_HTB_HPP__
#define __LINUX_ROUTING_QUEUEING_HTB_HPP__

#include <stdint.h>

#include <string>

#include <stout/hashmap.hpp>
#include <stout/try.hpp>

#include "linux/routing/handle.hpp"

namespace routing {
namespace queueing {
namespace htb {

constexpr char KIND[] = "htb";

// Returns true if there exists an htb queueing discipline on the
// egress side of the link.
Try<bool> exists(
    const std::string& link,
    const Handle& parent);


// Creates a new htb queueing discipline on the egress side of
// the link. Returns false if a queueing discipline already exists which
// prevents the creation.
Try<bool> create(
    const std::string& link,
    const Handle& parent,
    const Option<Handle>& handle);


// Removes the htb queueing discipline from the link. Returns
// false if the htb queueing discipline is not found.
Try<bool> remove(
    const std::string& link,
    const Handle& parent);


// Returns the set of common Traffic Control statistics for the
// htb queueing discipline on the link, None() if the link or
// qdisc does not exist or an error if we cannot cannot determine the
// result.
Result<hashmap<std::string, uint64_t>> statistics(
    const std::string& link,
    const Handle& parent);


} // namespace htb {
} // namespace queueing {
} // namespace routing {

#endif // __LINUX_ROUTING_QUEUEING_HTB_HPP__