# Module node_details

- Description
- Data Types
- Function Index
- Function Details

Node summary for statistics.

Copyright © 2007-2011 Zuse Institute Berlin

Version: $Id$

Authors: Thorsten Schuett (`schuett@zib.de`).

## Description

Node summary for statistics

## Data Types

### hostname()

    hostname() = string()

### load()

    load() = integer()

### load2()

    load2() = lb_stats:load()

### load3()

    load3() = lb_stats:load()

### memory()

    memory() = non_neg_integer()

### message_log()

    message_log() = any()

### node_details()

abstract datatype: `node_details()`

### node_details_name()

    node_details_name() =
        predlist |
        pred |
        node |
        my_range |
        succ |
        succlist |
        load |
        hostname |
        rt_size |
        message_log |
        memory |
        new_key |
        db |
        is_leaving

### rt_size()

    rt_size() = integer()

## Function Index

contains/2 | Checks whether the given data is available in a node details object.
get/2 | Gets the value of the given data in a node details object.
new/0 | Creates an empty node details object.
new/9 | Creates a new node details object with the given data.
set/3 | Adds the given data to the node list object.

## Function Details

### new/0

    new() -> node_details()

Creates an empty node details object.

### new/9

    new(PredList :: nodelist:non_empty_snodelist(),
        Node :: node:node_type(),
        SuccList :: nodelist:non_empty_snodelist(),
        Load :: load(),
        Load2 :: load2(),
        Load3 :: load3(),
        Hostname :: hostname(),
        RTSize :: rt_size(),
        Memory :: memory()) ->
           node_details()

Creates a new node details object with the given data.

### set/3

    set(NodeDetails :: node_details(),
        Key :: predlist,
        Value :: nodelist:non_empty_snodelist()) ->
           node_details()

Adds the given data to the node list object. Beware: Setting pred/succ will overwrite predlist/succlist! (pred and succ are only shortcuts for hd(predlist)/hd(succlist))

### contains/2

    contains(NodeDetails :: node_details(),
             Key :: node_details_name()) ->
                boolean()

Checks whether the given data is available in a node details object.

### get/2

    get(Node_details :: node_details(), Key :: predlist | succlist) ->
           nodelist:non_empty_snodelist()

Gets the value of the given data in a node details object. Will throw an exception if the value can not be located.

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