Current section
Files
Jump to
Current section
Files
doc/ExPomodoro.PomodoroServer.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.29.1">
<meta name="project" content="ExPomodoro v0.1.0">
<title>ExPomodoro.PomodoroServer — ExPomodoro v0.1.0</title>
<link rel="stylesheet" href="dist/html-elixir-V2ETBPMB.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-IV5W3OL2.js"></script>
<script src="dist/sidebar_items-A27BE2CD.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-XN2TSG4M.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="ExPomodoro.html" class="sidebar-projectName" translate="no">
ExPomodoro
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.1.0
</strong>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">ExPomodoro.PomodoroServer</span>
<small class="app-vsn" translate="no">(ExPomodoro v0.1.0)</small>
</h1>
<section id="moduledoc">
<p>The Pomodoro Server implementation</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:init_args/0" translate="no">init_args()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:state/0" translate="no">state()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#child_spec/1" translate="no">child_spec(init_arg)</a>
</div>
<div class="summary-synopsis"><p>Returns a specification to start this module under a supervisor.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_state/1" translate="no">get_state(pid)</a>
</div>
<div class="summary-synopsis"><p>Given a pid, returns the current state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#initial_state/1" translate="no">initial_state(opts)</a>
</div>
<div class="summary-synopsis"><p>Given a keyword of args returns a new map that represents the Elixir.ExPomodoro.PomodoroServer
state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#pause/1" translate="no">pause(pid)</a>
</div>
<div class="summary-synopsis"><p>Given a pid, pauses a pomodoro and returns the current pomodoro state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#resume/1" translate="no">resume(pid)</a>
</div>
<div class="summary-synopsis"><p>Given a pid, resumes a pomodoro and returns the current pomodoro state.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#start_link/1" translate="no">start_link(init_args)</a>
</div>
<div class="summary-synopsis"><p>Given a keyword of arguments, starts a Elixir.GenServer process linked to the
current process.</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Types
</h1>
<div class="types-list">
<section class="detail" id="t:init_args/0">
<div class="detail-header">
<a href="#t:init_args/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">init_args()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L11" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> init_args() :: [
id: <a href="ExPomodoro.Pomodoro.html#t:id/0">ExPomodoro.Pomodoro.id</a>(),
exercise: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(),
break: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(),
rounds: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()
]</pre>
</div>
</section>
</section>
<section class="detail" id="t:state/0">
<div class="detail-header">
<a href="#t:state/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">state()</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L18" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> state() :: %{
activity_ref: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">reference</a>() | nil,
id: <a href="ExPomodoro.Pomodoro.html#t:id/0">ExPomodoro.Pomodoro.id</a>(),
pomodoro: <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>(),
previous_activity: <a href="ExPomodoro.Pomodoro.html#t:activity/0">ExPomodoro.Pomodoro.activity</a>() | nil,
previous_activity_timeleft: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
timeout: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(),
timeout_ref: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">reference</a>() | nil
}</pre>
</div>
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="child_spec/1">
<div class="detail-header">
<a href="#child_spec/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">child_spec(init_arg)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L5" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns a specification to start this module under a supervisor.</p><p>See <a href="https://hexdocs.pm/elixir/Supervisor.html"><code class="inline">Supervisor</code></a>.</p>
</section>
</section>
<section class="detail" id="get_state/1">
<div class="detail-header">
<a href="#get_state/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_state(pid)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L58" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_state(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()</pre>
</div>
<p>Given a pid, returns the current state.</p>
</section>
</section>
<section class="detail" id="initial_state/1">
<div class="detail-header">
<a href="#initial_state/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">initial_state(opts)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L77" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> initial_state(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()) :: <a href="#t:state/0">state</a>()</pre>
</div>
<p>Given a keyword of args returns a new map that represents the Elixir.ExPomodoro.PomodoroServer
state.</p>
</section>
</section>
<section class="detail" id="pause/1">
<div class="detail-header">
<a href="#pause/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">pause(pid)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L64" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> pause(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: {:ok, <a href="#t:state/0">state</a>()}</pre>
</div>
<p>Given a pid, pauses a pomodoro and returns the current pomodoro state.</p>
</section>
</section>
<section class="detail" id="resume/1">
<div class="detail-header">
<a href="#resume/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">resume(pid)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L70" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> resume(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()) :: {:ok, <a href="ExPomodoro.Pomodoro.html#t:t/0">ExPomodoro.Pomodoro.t</a>()}</pre>
</div>
<p>Given a pid, resumes a pomodoro and returns the current pomodoro state.</p>
</section>
</section>
<section class="detail" id="start_link/1">
<div class="detail-header">
<a href="#start_link/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">start_link(init_args)</h1>
<a href="https://github.com/sgobotta/ex_pomodoro/blob/main/lib/ex_pomodoro/pomodoro_server.ex#L52" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> start_link(<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">keyword</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pid</a>()}</pre>
</div>
<p>Given a keyword of arguments, starts a Elixir.GenServer process linked to the
current process.</p><h3 id="start_link/1-args" class="section-heading">
<a href="#start_link/1-args" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">args</p>
</a>
Args:
</h3>
<ul><li><code class="inline">id</code>: <em>(required)</em> unique string to identify a pomodoro struct.</li><li><code class="inline">exercise</code>: <em>(optional)</em> an integer that represents the duration of the time
spent on exercise in milliseconds.</li><li><code class="inline">break</code>: <em>(optional)</em> an integer that represents the break duration in
milliseconds.</li><li><code class="inline">rounds</code>: <em>(optional)</em> an integer that represents the amount of rounds until
the pomodoro stops.</li><li><code class="inline">timeout</code>: <em>(optional)</em> milliseconds until the server is terminated by
inactiviy.</li></ul>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<a href="https://hex.pm/packages/ex_pomodoro/0.1.0" class="footer-hex-package">Hex Package</a>
<a href="https://preview.hex.pm/preview/ex_pomodoro/0.1.0">Hex Preview</a>
(<a href="https://preview.hex.pm/preview/ex_pomodoro/0.1.0/show/lib/ex_pomodoro/pomodoro_server.ex">current file</a>)
</span>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="ExPomodoro.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>