Changes between Initial Version and Version 1 of export_generic


Ignore:
Timestamp:
02/29/12 15:58:58 (10 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • export_generic

    v1 v1  
     1[[PageOutline]] 
     2 
     3= [wiki:Earthworm Earthworm] Module: = 
     4'''Contributed by: ''' 
     5 
     6== Function == 
     7Exports EARTHWORM messages over Internet (partner to import_generic). 
     8 
     9== Details == 
     10[wiki:Import-Export Import-Export Overview] 
     11 
     12=== EXAMPLE CONFIGURATION FILE === 
     13 
     14{{{ 
     15#   export_generic configuration file 
     16# 
     17#Background: 
     18# Import/Export are the long-distance message transfer 
     19# modules. They operate as one-on-one pairs. There are two variants of 
     20# export: export_generic, which ships messages with specified logos, and 
     21# export_scn which ships only trace data, but with specified SCN names. 
     22# 
     23# Import/Export send heartbeats to each other, as well as into their 
     24# local earthworm systems. If the heartbeat from the distant partner is 
     25# not received whithin the expected time period (RcvAliveInt) the link is 
     26# terminated, and an attempt to reconnect is initiated. If things go 
     27# seriously wrong, the heartbeat into the local earthworm system in 
     28# stopped. The expectation is that "restartMe" has been set in the .desc 
     29# file, and we'll be killed and restarted. 
     30# 
     31# All socket operations are performed with a timeout. This is noramlly 
     32# defaulted, but can be set in this file (SocketTimeout). 
     33# 
     34# Export maintains a circular FIFO buffer of messages to be shipped. The 
     35# size of this buffer (RingSize) controls the maximum latency of the 
     36# data. 
     37# 
     38# 
     39#Configuration notes: 
     40# 
     41# "restartMe" should be stated in our desc file. 
     42# 
     43# The period of our local heartbeat (HeartBeatInt) must be safely smaller 
     44# (faster) than our advertised period in our .desc file (tsec:). 
     45# Otherwise we'll get continually restarted for no good reason. 
     46# Note that tsec:0 implies no heartbeats expected, and so we'll never get 
     47# restarted. 
     48# 
     49# The rate at which we send heartbeats to our distant partner should be 
     50# considerably faster than the rate at which our partner expects them. 
     51# Otherwise, a heartbeat delayed in transmission will cause our partner to 
     52# conclude that the link is broken, and cause them to break the link and 
     53# reinitialize. Which will cause us to do the same. 
     54# 
     55# For export, the ServerIPAdr is  the address of the port to be used in 
     56# the exporting machine.  This is to specify a network card case the 
     57# exporting machine has several network cards. 
     58# 
     59# If SocketTimeout is specified, it should be at least as large as the 
     60# expected period of heartbeats from our distant partner. 
     61 
     62# 
     63 MyModuleId     MOD_EXPORT_GENERIC  # module id for this program 
     64 RingName       PICK_RING           # transport ring to use for input/output 
     65 HeartBeatInt   30                  # EW internal heartbeat interval (sec) 
     66#                                     Should be >= RcvAliveInt 
     67 LogFile        1                   # If 0, don't write logfile 
     68# 
     69# Logos of messages to export to client systems 
     70#              Installation       Module       Message Type 
     71 GetMsgLogo    INST_MENLO      MOD_WILDCARD     TYPE_PICK2K 
     72 GetMsgLogo    INST_MENLO      MOD_WILDCARD     TYPE_CODA2K 
     73 
     74# ServerIPAdr and ServerPort specify the local IP address and port number 
     75# on which this module will be ready to accept a client connection. 
     76# 
     77 ServerIPAdr  aaa.bbb.ccc.dd   # Export messages via this ethernet card 
     78 ServerPort     16005          # Well-known port number to export msgs on 
     79 
     80 MaxMsgSize       128          # maximum size (bytes) for input/output msgs 
     81 RingSize         100          # number of msgs to buffer for export 
     82 
     83 SendAliveText   "alive"       # string sent to client as heartbeat 
     84 SendAliveInt      30          # seconds between alive msgs sent to client. 
     85                               #  0=> no heartbeat 
     86 RcvAliveText    "alive"       # text of client's heartbeat (we get this) 
     87 RcvAliveInt       150         # seconds between client's heartbeats to us. 
     88                               #  0 => no heartbeat 
     89# 
     90# Socket commands 
     91# 
     92# The commands below are optional. 
     93# SocketTimeout defaults to RcvAliveInt plus three seconds 
     94# If specified, it must be greater than RcvAliveInt 
     95# SocketDebug defaults to 0 
     96 SocketTimeout 200000  # Timeout length in milliseconds for socket calls 
     97                       # this should be atleast the value of the RcvAliveInt 
     98 SocketDebug   0       # if 1, socket_ew debug statements are logged 
     99                       # if 0, socket_ew debug is turned off 
     100}}} 
     101 
     102== Helpful Hints ==