DXSpider Variables Reference

The list of variable comes from the files and code in the /spider/perl directory.

WARNING! If you are unsure of what you are doing, backup all files before make changes otherwise you are likely to break your installation.

This is a list of the variables found in the various files and code of the DXSpider cluster programs written by Dirk Koopman, G1TLH.

$ - scalar variable

@ - array variable

% - hash variable

/spider/perl

AGWMsg

$AGWMsg::enable - enable the AGW engine (1)
$AGWMsg::login - user name you are logging in as
$AGWMsg::passwd - login password
$AGWMsg::addr - ip addres of the AGW engine you are logging in to
$AGWMsg::port - the listening port of the AGW engine
$AGWMsg::monitor - default monitor status
$AGWMsg::ypolltime - time between polls of channel queues
$AGWMsg::hpolltime - time between polls of Mheard

AnnTalk

$AnnTalk::duplth - the length of text to use in the deduping
$AnnTalk::dupage - the length of time to hold ann dupes
$AnnTalk::filterdef - declaration of filtering definitions 

Bands

%Bands::bands - the 'raw' band data
%Bands::regions - list of regions for shortcuts eg. vhf ssb
%Bands::aliases - list of aliases

BBS

%BBS::bid - bid hash
$BBS::bidfn - the bid file filename
$BBS::lastbidclean - the last time the bid file was cleaned
$BBS::bidcleanint - the time between bid cleaning intervals
$BBS::maxbidage - the maximum age of a stored bid

BPQMsg

$BPQMsg::enable - set to 1 to enable BPQ handling
$BPQMsg::ApplMask - Applmask is normally 1, unless you are already running another BPQ app such as a BBS
$BPQMsg::BPQStreams - streams to allocate - used for both incoming and outgoing connects 

main

$main::version - DXSpider version
$main::root - dxspider filesystem root path
$main::systime - the time now (in seconds)
@main::inqueue - the main input queue, an array of hashes
$main::starttime - the starting time of the cluster
@main::outstanding_connects - list of outstanding connects
@main::listeners - list of listeners
$main::lang - default language
$main::clusteraddr - cluster tcp host address - used for things like console.pl
$main::clusterport - cluster tcp port
$main::reqreg - 1 = registration required 2 = deregister people
$main::bumpexisting - 1 = allow new connection to disconnect old, 0 - don't allow it
$main::allowdxby - 1 = allow "dx by <othercall>", 0 - don't allow it
$main::maxconnect_user - the maximum no of concurrent connections a user can have at a time
$main::maxconnect_node - Ditto but for nodes. In either case if a new incoming connection takes the no of   references in the routing table above these numbers then the connection is refused. This only affects INCOMING connections.
$main::idle_interval - the wait between invocations of the main idle loop processing
$main::log_flush_interval - interval to wait between log flushes
$main::broadcast_debug - allow broadcasting of debug info down "enhanced" user connections
$main::yes - visual representation of yes
$main::no - visual representation of no
$main::user_interval - the interval between unsolicited prompts if no traffic
$main::local_data - path to local_data dir
$main::localcmd - path to local_cmd dir
$main::cmd - path to cmd dir
$main::system - path to system dir
$main::data - path to data dir
$main::allowslashcall - Allow / in connecting callsigns (ie PA0/G1TLH, or even PA0/G1TLH/2)
$main::localhost_alias_ipv4 - these are the IPV4 & 6 aliases for localhost connected clients
$main::localhost_alias_ipv6 - for things (PC92, PC61 etc) that expose IP addresses. These *may* be set by  Msg.pm stuff if they are left undefined but, if you need certanty then set/var them in the startup file.
$main::save_route_cache - save and restore route cache on restart. Probably only useful for G1TLH testing
$main::foreground - foreground color from Console.pm (see Console.pm header)
$main::background - background color from Console.pm (see Console.pm header)
$main::mycallcolor - color of mycall from Console.pm (see Console.pm header)
$main::mycall - call of the node in capital letters
$main::myname - sysop name
$main::myalias - sysop callsign
$main::mylatitude - Your latitude (+)ve = North (-)ve = South in degrees and decimal degrees
$main::mylongitude - Your Longtitude (+)ve = East, (-)ve = West in degrees and decimal degrees
$main::mylocator - Your locator (USE CAPITAL LETTERS)
$main::myqth - Your QTH (roughly), SomeTown, SomeState
$main::myemail - your e-mail address
@main::my_cc - the country codes that my node is located in
@main::debug - are we debugging
$main::do_xml - are we doing XML
$main::dsn = the SQL database DBI dsn
$main::dbuser - database user login
$main::dbpass - database password login
$main::data - data file directory path
$main::local_data - local_data directory path
$main::system - system files live in (except they don't, not really)
$main::cmd - command file directory path
$main::localcmd - local command file directory path
$main::userfn - user data file directory path
$main::motd - message of the day file