Module vivaldi_latency

Description
Data Types
Function Index
Function Details

Vivaldi helper module for measuring latency between nodes.

Version: $Id$

Behaviours: gen_component.

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

Description

Vivaldi helper module for measuring latency between nodes.

Data Types

message()

message() = {{pong,
              PidName :: pid_groups:pidname() | undefined},
             Count :: pos_integer()}
          | {start_ping}
          | {shutdown}
          | {'DOWN',
             MonitorRef :: reference(),
             process,
             Owner :: comm:erl_local_pid(),
             Info :: any()}

state()

state() = 
    {Owner :: comm:erl_local_pid(),
     RemotePid :: comm:mypid(),
     Token ::
         {gossip_vivaldi:network_coordinate(),
          gossip_vivaldi:est_error()},
     Start :: erlang:timestamp() | unknown,
     Count :: non_neg_integer(),
     Latencies :: [gossip_vivaldi:latency()]}

Function Index

check_config/0	Checks whether config parameters of the vivaldi_latency process exist and are valid.
init/1
measure_latency/3
on/2	message handler.

Function Details

on/2

on(Message :: message(), State :: state()) -> state()

message handler

init/1

init(X1 ::
         {pid(),
          comm:mypid(),
          {gossip_vivaldi:network_coordinate(),
           gossip_vivaldi:est_error()}}) ->
        state()

measure_latency/3

measure_latency(RemotePid :: comm:mypid(),
                RemoteCoordinate ::
                    gossip_vivaldi:network_coordinate(),
                RemoteConfidence :: gossip_vivaldi:est_error()) ->
                   {ok, pid()}

check_config/0

check_config() -> boolean()

Checks whether config parameters of the vivaldi_latency process exist and are valid.

Generated by EDoc, Jul 23 2015, 22:07:46.