/usr/include/simgrid/s4u/Link.hpp is in libsimgrid-dev 3.18+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef S4U_LINK_HPP_
#define S4U_LINK_HPP_
#include <simgrid/link.h>
#include <string>
#include <unordered_map>
#include <xbt/Extendable.hpp>
#include <xbt/base.h>
#include <xbt/signal.hpp>
/***********
* Classes *
***********/
namespace simgrid {
namespace surf {
class NetworkAction;
};
namespace s4u {
/** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
XBT_PUBLIC_CLASS Link : public simgrid::xbt::Extendable<Link>
{
friend simgrid::surf::LinkImpl;
// Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
virtual ~Link() = default;
// The private implementation, that never changes
surf::LinkImpl* const pimpl_;
public:
/** @brief Retrieve a link from its name */
static Link* byName(const char* name);
/** @brief Retrieves the name of that link as a C++ string */
const std::string& getName() const;
/** @brief Retrieves the name of that link as a C string */
const char* getCname() const;
/** @brief Get the bandwidth in bytes per second of current Link */
double bandwidth();
/** @brief Get the latency in seconds of current Link */
double latency();
/** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
*/
int sharingPolicy();
/** @brief Returns the current load (in flops per second) */
double getUsage();
/** @brief Check if the Link is used */
bool isUsed();
void turnOn();
void turnOff();
void* getData();
void setData(void* d);
void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
boolean values. */
void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
external load). Trace must contain percentages (value between 0 and 1). */
void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
external load). Trace must contain absolute values */
const char* getProperty(const char* key);
void setProperty(std::string key, std::string value);
/* The signals */
/** @brief Callback signal fired when a new Link is created */
static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
/** @brief Callback signal fired when a Link is destroyed */
static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
/** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
/** @brief Callback signal fired when a communication starts */
static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
/** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") const char* name();
};
}
}
#endif /* SURF_NETWORK_INTERFACE_HPP_ */
|