Module comm_connection

Description
Data Types
Function Index
Function Details

creates and destroys connections and represents the endpoint of a connection where messages are received from and send to the network.

Version: $Id$

Behaviours: gen_component.

Authors: Thorsten Schuett (schuett@zib.de), Florian Schintke (schintke@zib.de).

Description

creates and destroys connections and represents the endpoint of a connection where messages are received from and send to the network.

Data Types

message()

message() = {send,
             DestPid :: pid(),
             Message :: comm:message(),
             Options :: comm:send_options()}
          | {tcp, Socket :: inet:socket(), Data :: binary()}
          | {tcp_closed, Socket :: inet:socket()}
          | {report_stats}
          | {web_debug_info, Requestor :: comm:erl_local_pid()}

msg_or_tag()

msg_or_tag() = comm:message() | comm:msg_tag()

msg_queue()

msg_queue() = 
    {MQueue :: [{DestPid :: pid(), Message :: comm:message()}],
     OQueue :: [comm:send_options()]}

stat_report()

stat_report() = 
    {RcvCnt :: non_neg_integer(),
     RcvBytes :: non_neg_integer(),
     SendCnt :: non_neg_integer(),
     SendBytes :: non_neg_integer()}

state()

state() = 
    {DestIP :: inet:ip_address(),
     DestPort :: comm_server:tcp_port(),
     LocalListenPort :: comm_server:tcp_port(),
     Channel :: comm:channel(),
     Socket :: inet:socket() | notconnected,
     StartTime :: erlang:timestamp(),
     SentMsgCount :: non_neg_integer(),
     ReceivedMsgCount :: non_neg_integer(),
     MsgQueue :: msg_queue(),
     MsgQueueLen :: non_neg_integer(),
     DesiredBundleSize :: non_neg_integer(),
     MsgsSinceBundleStart :: non_neg_integer(),
     LastStatReport :: stat_report(),
     TimeLastMsgSent :: time_last_msg(),
     TimeLastMsgReceived :: time_last_msg(),
     SentMsgCountSession :: non_neg_integer(),
     ReceivedMsgCountSession :: non_neg_integer(),
     SessionCount :: non_neg_integer(),
     LastMsgSent :: [msg_or_tag()],
     LastMsgReceived :: [msg_or_tag()]}

time_last_msg()

time_last_msg() = erlang:timestamp()

Function Index

init/1	initialize: return initial state.
on/2	message handler.
start_link/6

Function Details

start_link/6

start_link(CommLayerGroup :: pid_groups:groupname(),
           DestIP :: inet:ip_address(),
           DestPort :: comm_server:tcp_port(),
           Socket :: inet:socket() | notconnected,
           Channel :: comm:channel(),
           Dir :: rcv | send | both) ->
              {ok, pid()}

init/1

init(X1 ::
         {DestIP :: inet:ip_address(),
          DestPort :: comm_server:tcp_port(),
          LocalListenPort :: comm_server:tcp_port(),
          Channel :: comm:channel(),
          Socket :: inet:socket() | notconnected}) ->
        state()

initialize: return initial state.

on/2

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

message handler

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