Git Product home page Git Product logo

idle_timeout_ex's Introduction

IdleTimeout

A simple mechanism to timeout idle Elixir processes - for example a GenServer - after a given period of inactivity.

Design goals

  • Good interface
  • Minimal overhead
  • Obvious implementation

Interface

Setup the timeout watchdog in GenServer.init/3:

IdleTimeout.start __MODULE__, 2000

First argument must be any unique ID, second argument is the first / default timeout. Your GenServer now has to ping the watchdog to prevent timeout:

IdleTimeout.ping __MODULE__

This will renew the last / default timeout. Optionally a new timeout can be given:

IdleTimeout.ping __MODULE__, 1000

Timeout only ever will get expanded, not shortened by later, shorter intervals.

Limitation

Doesn't work too well with short timeouts. Should be fine with anyting in the seconds range. My own usecase is several minutes.

Installation

If available in Hex, the package can be installed by adding idle_timeout_ex to your list of dependencies in mix.exs:

def deps do
  [{:idle_timeout_ex, "~> 0.1.0"}]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/idle_timeout_ex.

idle_timeout_ex's People

Contributors

niko avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

pragdave

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.