Changes between Version 4 and Version 5 of ringtocoaxII


Ignore:
Timestamp:
03/18/12 19:29:01 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ringtocoaxII

    v4 v5  
    161161Function: msg handling           
    162162 
    163 Specifies one message logo (instid, modid, and msgtype) to read from the shared memory region (named in the "!RingName" command) and to broadcast onto ethernet. The instid must be a valid string in earthworm.h; modid and msgtype must be valid strings in earthworm.d. List one logo per "!BroadcastLogo" command, and use as many commands as needed. If msgtype is TYPE_HEARTBEAT or TYPE_ERROR, be sure that the CopyStatus value is non-zero. If no "!BroadcastLogo" command is given, ringtocoax defaults to broadcasting all messages in the designated shared memory region. 
     163Specifies one message logo (instid, modid, and msgtype) to read from the shared memory region (named in the "!RingName" command) and to broadcast onto ethernet. The instid must be a valid string in earthworm.h; modid and msgtype must be valid strings in earthworm.d. List one logo per "!BroadcastLogo" command, and use as many commands as needed. If msgtype is TYPE_HEARTBEAT or TYPE_ERROR, be sure that the !CopyStatus value is non-zero. If no "!BroadcastLogo" command is given, ringtocoax defaults to broadcasting all messages in the designated shared memory region. 
    164164{{{ 
    165165Example:  BroadcastLogo INST_MENLO MOD_WILDCARD TYPE_TRACEBUF 
     
    169169Processed by: ringtocoax_config[[BR]] 
    170170Function: msg handling 
    171                  
    172 Defines the number of UDP packets, !BurstCount, in a broadcast "burst". Three commands, "!BurstCount", "!SqrtCount", and "!BurstInterval", control the temporal spacing of UDP packets broadcast by ringtocoax. Ringtocoax broadcasts messages in groups of BurstCount packets; between the packets within a "burst", ringtocoax loops thru !SqrtCount square root calculations to waste a little time. After broadcasting a "burst" of packets, ringtocoax sleeps for BurstInterval milliseconds, then it starts sending the next burst. The goal of spacing packets a tiny bit in time is to give the receiving program a better chance of catching every packet. 
     171 
     172Defines the number of UDP packets, !BurstCount, in a broadcast "burst". Three commands, "!BurstCount", "!SqrtCount", and "!BurstInterval", control the temporal spacing of UDP packets broadcast by ringtocoax. Ringtocoax broadcasts messages in groups of !BurstCount packets; between the packets within a "burst", ringtocoax loops thru !SqrtCount square root calculations to waste a little time. After broadcasting a "burst" of packets, ringtocoax sleeps for !BurstInterval milliseconds, then it starts sending the next burst. The goal of spacing packets a tiny bit in time is to give the receiving program a better chance of catching every packet. 
    173173 
    174174UDP packets are variable in length up to a maximum of 1472 bytes (6 bytes of header, 1466 bytes of data). If an Earthworm message has a length less than or equal to 1466 bytes, it will be broadcast in a single UDP packet. If an Earthworm message is longer than 1466 bytes, it will be fragmented by ringtocoax, broadcast in multiple UDP packets, and reassembled by the receiving program (coaxtoring). Ringtocoax will never pack more than one Earthworm message in a single UDP packet. 
     
    184184Function: msg handling           
    185185 
    186 Defines the minimum interval, in milliseconds, between "bursts" of UDP broadcasts. See the !BurstCount command for a detailed description of ringtocoax's broadcasting scheme. !BurstInterval must be a number greater than or equal to zero. Remember to consider the system clock resolution when configuring BurstInterval. As of April 1999, the clock-tick resolution is about 16 msec on Windows NT, and about 10 msec on Solaris. 
     186Defines the minimum interval, in milliseconds, between "bursts" of UDP broadcasts. See the !BurstCount command for a detailed description of ringtocoax's broadcasting scheme. !BurstInterval must be a number greater than or equal to zero. Remember to consider the system clock resolution when configuring !BurstInterval. As of April 1999, the clock-tick resolution is about 16 msec on Windows NT, and about 10 msec on Solaris. 
    187187{{{ 
    188188Default:  none 
     
    194194Function: msg handling 
    195195 
    196 Sets the !CopyStatus switch to control whether ringtocoax broadcasts TYPE_ERROR and TYPE_HEARTBEAT messages. If no "!BroadcastLogo" command is present, then ringtocoax will default to reading all messages in the shared memory region specified by the "!RingName" command. If !CopyStatus is non-zero, all of these messages will be broadcast onto ethernet. If CopyStatus is 0, TYPE_HEARTBEAT and TYPE_ERROR will not be broadcast, but all other messages will. 
     196Sets the !CopyStatus switch to control whether ringtocoax broadcasts TYPE_ERROR and TYPE_HEARTBEAT messages. If no "!BroadcastLogo" command is present, then ringtocoax will default to reading all messages in the shared memory region specified by the "!RingName" command. If !CopyStatus is non-zero, all of these messages will be broadcast onto ethernet. If !CopyStatus is 0, TYPE_HEARTBEAT and TYPE_ERROR will not be broadcast, but all other messages will. 
    197197{{{ 
    198198Default:  none 
     
    203203Processed by: ringtocoax_config[[BR]] 
    204204Function: Earthworm setup 
    205          
     205 
    206206Defines the number of seconds nsec between TYPE_HEARTBEAT messages issued by ringtocoax. 
    207207{{{ 
     
    212212'''!LogSwitch [switch]'''[[BR]] 
    213213Processed by: ringtocoax_config[[BR]] 
    214 Function: output         
    215          
     214Function: output 
     215 
    216216Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, ringtocoax will write a daily log file(s) called ringtocoaxxx.log_ccyymmdd where xx is ringtocoax's module id (set with "!MyModName" command) and ccyymmdd is the current UTC date (ex: 19990123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
    217217{{{