# Module rdht_tx

- Description
- Data Types
- Function Index
- Function Details

API for transactions on replicated DHT items.

Copyright © 2009-2014 Zuse Institute Berlin

Version: $Id$

Authors: Florian Schintke (`schintke@zib.de`), Nico Kruber (`kruber@zib.de`).

## Description

API for transactions on replicated DHT items.

## Data Types

### client_value()

    client_value() = any()

### encoded_value()

    encoded_value() = atom() | boolean() | number() | binary()

### req_id()

    req_id() = uid:global_uid()

### request_on_key()

    request_on_key() = api_tx:request_on_key()

## Function Index

check_config/0 | Checks whether used config parameters exist and are valid.
decode_value/1 | Decodes the given internal representation of a client value.
encode_value/1 | Encode the given client value to its internal representation which is compressed for all values except atom, boolean, number or binary.
is_encoded_value/1 |
req_get_key/1 |
req_get_op/1 |
req_list/3 | Perform several requests inside a transaction.
req_props/1 |

## Function Details

### req_list/3

    req_list(TLog :: tx_tlog:tlog_ext(),
             ReqList :: [api_tx:request()],
             EnDecode :: true) ->
                {tx_tlog:tlog_ext(), [api_tx:result()]}

Perform several requests inside a transaction.

### req_props/1

    req_props(Req :: request_on_key()) ->
                 {NeedsFullRead :: boolean(),
                  WorksAfterAnyPartialRead :: boolean(),
                  ProvidesFullRead :: boolean()}

### is_encoded_value/1

    is_encoded_value(Value :: term()) -> boolean()

### encode_value/1

    encode_value(Value :: client_value()) -> encoded_value()

Encode the given client value to its internal representation which is compressed for all values except atom, boolean, number or binary.

### decode_value/1

    decode_value(Value :: encoded_value()) -> client_value()

Decodes the given internal representation of a client value.

### req_get_op/1

    req_get_op(Request :: api_tx:request_on_key()) ->
                  read |
                  write |
                  add_del_on_list |
                  add_on_nr |
                  test_and_set

### req_get_key/1

    req_get_key(Request :: api_tx:request_on_key()) ->
                   api_tx:client_key()

### check_config/0

    check_config() -> boolean()

Checks whether used config parameters exist and are valid.

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