-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathclient.html
More file actions
184 lines (163 loc) · 9.68 KB
/
client.html
File metadata and controls
184 lines (163 loc) · 9.68 KB
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User Guide for Client APIs — GEOPM documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/colon_scheme_fix.js?v=ca089989"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="User Guide for GEOPM Runtime" href="runtime.html" />
<link rel="prev" title="User Guide for GEOPM Access Service" href="service.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
GEOPM
<img src="https://geopm.github.io/images/geopm-logo-clear.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Install Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="security.html">Security Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="user_guides.html">User Guides</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="service.html">User Guide for GEOPM Access Service</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">User Guide for Client APIs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#language-bindings">Language Bindings</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#c-api">C API</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id1">C++ API</a></li>
<li class="toctree-l4"><a class="reference internal" href="#python3-api">Python3 API</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#command-line-tools">Command Line Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="runtime.html">User Guide for GEOPM Runtime</a></li>
<li class="toctree-l2"><a class="reference internal" href="frequency_guide.html">User Guide for Frequency Control</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">Contributor Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="devel.html">Developer Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">GEOPM</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="user_guides.html">User Guides</a></li>
<li class="breadcrumb-item active">User Guide for Client APIs</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/client.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="user-guide-for-client-apis">
<h1>User Guide for Client APIs<a class="headerlink" href="#user-guide-for-client-apis" title="Link to this heading"></a></h1>
<p>The GEOPM Service enhances the PlatformIO interfaces by ensures
reliability and quality. Users of the GEOPM service can
utilize the PlatformIO capabilities through different interfaces
such as C, C++, Python, and command line tools. The system
administrator can manage user access rights through using the <code class="docutils literal notranslate"><span class="pre">geopmaccess</span></code>
command line tool. PlatformTopo is an abstraction that outlines the
system’s hardware.</p>
<p>An comprehensive overview of the PlatformIO abstraction is outlined in
the <a class="reference internal" href="geopm_pio.7.html"><span class="doc">geopm_pio(7)</span></a> man page. This page along with
the linked pages describe all signals and controls available
through this interface. Clients can read the signals or utilizes the
controls explained in the overview with the interfaces provided below.</p>
<section id="language-bindings">
<h2>Language Bindings<a class="headerlink" href="#language-bindings" title="Link to this heading"></a></h2>
<section id="c-api">
<h3>C API<a class="headerlink" href="#c-api" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="geopm_pio.3.html"><span class="doc">geopm_pio(3)</span></a></p></li>
<li><p><a class="reference internal" href="geopm_topo.3.html"><span class="doc">geopm_topo(3)</span></a></p></li>
</ul>
</section>
<section id="id1">
<h3>C++ API<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="geopm%3A%3APlatformIO.3.html"><span class="doc">geopm::PlatformIO(3)</span></a></p></li>
<li><p><a class="reference internal" href="geopm%3A%3APlatformTopo.3.html"><span class="doc">geopm::PlatformTopo(3)</span></a></p></li>
</ul>
</section>
<section id="python3-api">
<h3>Python3 API<a class="headerlink" href="#python3-api" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="geopmdpy.7.html#module-geopmdpy.pio"><span class="std std-ref">geopmdpy.pio</span></a></p></li>
<li><p><a class="reference internal" href="geopmdpy.7.html#module-geopmdpy.topo"><span class="std std-ref">geopmdpy.topo</span></a></p></li>
</ul>
</section>
</section>
<section id="command-line-tools">
<h2>Command Line Tools<a class="headerlink" href="#command-line-tools" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Read a single value: <a class="reference internal" href="geopmread.1.html"><span class="doc">geopmread(1)</span></a></p></li>
<li><p>Write a single value: <a class="reference internal" href="geopmwrite.1.html"><span class="doc">geopmwrite(1)</span></a></p></li>
<li><p>Prometheus exporter <a class="reference internal" href="geopmexporter.1.html"><span class="doc">geopmsession(1)</span></a></p></li>
<li><p>Read time series of values <a class="reference internal" href="geopmsession.1.html"><span class="doc">geopmsession(1)</span></a></p></li>
<li><p>Manage access <a class="reference internal" href="geopmaccess.1.html"><span class="doc">geopmaccess(1)</span></a></p></li>
<li><p>Define control grid <a class="reference internal" href="geopmgrid.1.html"><span class="doc">geopmgrid(1)</span></a></p></li>
<li><p>Optimize application <a class="reference internal" href="geopmopt.1.html"><span class="doc">geopmopt(1)</span></a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="service.html" class="btn btn-neutral float-left" title="User Guide for GEOPM Access Service" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="runtime.html" class="btn btn-neutral float-right" title="User Guide for GEOPM Runtime" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015 - 2025 Intel Corporation. All rights reserved..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>