# Parameter definitions for thorn ShmServ
# $Header$

private:
# triple buffer the shmem
# first byte allows writer to inform reader where in sequence 
# it is currently writing.  The reader informs writer where it
# is currently reading using second byte.  Writer never writes
# to same location used by reader??
# initially, lets be stupid about buffering. (single buffer)

STRING shmtoken "filename for shared memory token (unique ID used by ftok)"
{
  .* :: "A file path to a shared memory token (default uses /tmp to get local filesystem)"
} "/tmp/cactus"

INT output_every "How often to copy data to shmem" STEERABLE = ALWAYS
{
  1: :: "Some positive integer"
} 10

INT use_scavenger "Tag Packets to use Scavenger Service" STEERABLE = ALWAYS
{
  0: :: "0 if not, 1 or 8 if yes (why 8..  I don't know)"
} 0

INT output_start "First iteration to start copying data to shmem. (Default=1)" STEERABLE = ALWAYS
{
  1: :: "Some positive integer"
} 1

STRING output_var "name of gf to output (no default)"
{
 .* :: "name of valid GF or empty to disable"
} ""

STRING hostlist "List of hosts to send (round robin assignment for z-slices)"
{
 .* :: "comma separated list of hosts targeted for UDP traffic"
} "localhost:7000,localhost:7001,localhost:7002,localhost:7003"

REAL delay "Delay between successive UDP packet sends (will eventually be rate)" STEERABLE = ALWAYS
{
  *:* :: "Delay in seconds (zero disables delay checking entirely)"
} 0.01

INT override_swap_bytes "Will prevent byte swapping (primarily for IA64)"
{
  0: :: "Default is 0 (always use net byte order) for compatability"
} 0

REAL rate_mbps "As opposed to using delay, use a rate limiter to pace packets" STEERABLE = ALWAYS
{
  *:* :: "bitrate in megabits per second"
} 50.0

INT use_rate "Use the rate limiter rather than delay to pace packets"
{
  0: :: "Default is 0 (use delay to pace packets) for compatability"
} 0

INT packet_size "Set the packet size for UDP packets" STEERABLE = ALWAYS
{
  500: :: "packetsize in bytes cannot exceed MTU or bad things happen"
} 1470

INT protocol_version "Set the UDP packet protocol header version"
{
  1: :: "Default is 1 (initial version)  version 2 is 6-word header"
} 1

INT control_port "Set the Portnum to listen for visapult client connects"
{
  2000: :: "Default is 5777. (only enabled for protocol_version=3"
} 5777

INT strip_ghost "Strip ghost zones from the data before sending it"
{
  0: :: "Default is 0 (do not strip ghost zones)"
} 0

#############################################################################
### import IOUtil parameters
#############################################################################
shares: IO

####################
# verbose flag
####################
USES KEYWORD verbose