Current section
Files
Jump to
Current section
Files
docs/EnvConf.Server.html
<!DOCTYPE html>
<html>
<head>
<title>EnvConf.Server</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="content">
<h1>
EnvConf.Server
</h1>
<div id="moduledoc" class="docstring">
<p>The EnvConf Server is the main config service. It provides a few functions for getting and setting Config Values. </p>
<p>The current behavior for setting values requires that both the key and value be binaries. However there are get functions that will return a value of a specific type. </p>
</div>
<h2 id="functions_summary">Functions summary</h2>
<table class="summary">
<tr>
<td class="summary_signature"><a href="#get/1">get(key)</a></td>
<td class="summary_synopsis"><p>get takes a binary key value. It returns the binary stored in the system environment at that key.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#get_atom/1">get_atom(key)</a></td>
<td class="summary_synopsis"><p>get<em>atom takes a binary key value. It returns the result of calling Kernel.binary</em>to_atom on the binary stored in the system environment at the given key.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#get_boolean/1">get_boolean(key)</a></td>
<td class="summary_synopsis"><p>get_boolean takes a binary key value. If the value of that environment key is "false" or "FALSE" then it returns false. If the value of that environment key is "true" or "TRUE" then it returns true.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#get_number/1">get_number(key)</a></td>
<td class="summary_synopsis"><p>get<em>number takes a binary key value. It returns the result of calling Kernel.binary</em>to_integer on the binary stored in the system environment at that key.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#set/1">set(dict)</a></td>
<td class="summary_synopsis"><p>Translate the given HashDict to the system environment. Keys map to environment variables and values map to values.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#set/2">set(key, value)</a></td>
<td class="summary_synopsis"><p>Set the environment variable specified by key to the binary version of value.</p>
</td>
</tr>
<tr>
<td class="summary_signature"><a href="#start_link/1">start_link(defaults \\ [])</a></td>
</tr>
</table>
<div id="functions_details" class="details_list">
<h2>Functions</h2>
<div class="detail">
<p class="signature" id="get/1">
<strong>get(key)</strong>
</p>
<div class="docstring"><p>get takes a binary key value. It returns the binary stored in the system environment at that key.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="get_atom/1">
<strong>get_atom(key)</strong>
</p>
<div class="docstring"><p>get<em>atom takes a binary key value. It returns the result of calling Kernel.binary</em>to_atom on the binary stored in the system environment at the given key.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="get_boolean/1">
<strong>get_boolean(key)</strong>
</p>
<div class="docstring"><p>get_boolean takes a binary key value. If the value of that environment key is "false" or "FALSE" then it returns false. If the value of that environment key is "true" or "TRUE" then it returns true.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="get_number/1">
<strong>get_number(key)</strong>
</p>
<div class="docstring"><p>get<em>number takes a binary key value. It returns the result of calling Kernel.binary</em>to_integer on the binary stored in the system environment at that key.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="set/1">
<strong>set(dict)</strong>
</p>
<div class="docstring"><p>Translate the given HashDict to the system environment. Keys map to environment variables and values map to values.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="set/2">
<strong>set(key, value)</strong>
</p>
<div class="docstring"><p>Set the environment variable specified by key to the binary version of value.</p>
</div>
</div>
<div class="detail">
<p class="signature" id="start_link/1">
<strong>start_link(defaults \\ [])</strong>
</p>
<div class="docstring"></div>
</div>
</div>
</div>
</body>
</html>