# Module learner

- Description
- Data Types
- Function Index
- Function Details

Part of a generic Paxos-Consensus implementation The role of a learner.

Copyright © 2009-2015 Zuse Institute Berlin,

Version: $Id$

Behaviours: `gen_component`.

Authors: Florian Schintke (`schintke@zib.de`).

## Description

Part of a generic Paxos-Consensus implementation The role of a learner.

## Data Types

### state()

    state() = atom()

table name

## Function Index

check_config/0 | Checks whether config parameters exist and are valid.
init/1 |
on/2 |
start_gen_component/5 |
start_link/2 |
start_paxosid/5 |
start_paxosid_local/5 |
stop_paxosids/2 |

## Function Details

### start_gen_component/5

    start_gen_component(Module :: module(),
                        Handler :: gen_component:handler(),
                        Args :: term(),
                        Options :: [gen_component:option()],
                        Self :: pid()) ->
                           no_return() | ok

### start_paxosid/5

    start_paxosid(Learner :: comm:mypid(),
                  PaxosID :: any(),
                  Majority :: pos_integer(),
                  ProcessToInform :: comm:mypid(),
                  ClientCookie :: any()) ->
                     ok

### start_paxosid_local/5

    start_paxosid_local(Learner :: pid(),
                        PaxosID :: any(),
                        Majority :: pos_integer(),
                        ProcessToInform :: comm:mypid(),
                        ClientCookie :: any()) ->
                           ok

### stop_paxosids/2

    stop_paxosids(Learner :: comm:mypid(), ListOfPaxosIDs :: [any()]) ->
                     ok

### start_link/2

    start_link(DHTNodeGroup :: pid_groups:groupname(),
               PidName :: pid_groups:pidname()) ->
                  {ok, pid()}

### init/1

    init(X1 :: []) -> atom()

### on/2

    on(X1 :: comm:message(), ETSTableName :: state()) -> state()

### check_config/0

    check_config() -> boolean()

Checks whether config parameters exist and are valid.

Generated by EDoc, Feb 29 2016, 16:12:14.