view release on metacpan or  search on metacpan

lib/arcxd.pod  view on Meta::CPAN

arcxd [-d <loglevel>] [-p <port>] [-F <config file>] [-v]

=head2 Parameter

=over 4

=item -d <loglevel>

Let the server put its log output to "stderr" and set the log level to <loglevel>. Also tells the server to do not fork into the background.

=item -p <port>

On which port the server shall listen on. (override the one from the configuration file and the default port). Change this for testing purposes.

=item -P <pid_file>

Where should the Net::Server store the PID of the master process.

=item -F <config file>

Specify the configuration file, to fill ARCv2 appropriately. Default is arcxd.conf in the default path $Arc::Default Path.

=item -v

The verbose option. If this option is set, arcxd is verbose in its context. This option does not influence the ARCv2 object. Use -d for it.

=back

=head1 CONFIGURATION FILE

=head2 Example:

 [main]
   service = arc
   timeout = 30

 [arcd]
   host = 0
   post = 4242

   max_requests = 1000
   min_servers = 5
   max_servers = 50
   max_spare_servers = 10
   min_spare_servers = 2

   pid_file = /var/run/arcxd.pid
   
   sasl_mechanisms = <<EOM
 GSSAPI
 PLAIN
 EOM

 [commands]
   uptime = Arc::Command::Uptime
   whoami = Arc::Command::Whoami
   copy = Arc::Command::Get
   cp = Arc::Command::Get
   get = Arc::Command::Get
   put = Arc::Command::Put
   test = Arc::Command::Test
   help = Arc::Command::Help
   h = Arc::Command::Help
   hlp = Arc::Command::Help

 [logging]
   level = 7
   destination = syslog

The configuration file is based on .ini format, known from Windows (sorry). 
In perl we can parse it, using Config::IniFiles. The configuration file is divided into
several sections. Each section can have a several number of key/value pairs.

=head2 main

=over 4

=item service

The name of the service the SASL authentication mechanism shall use.

=item timeout

Timeout in seconds to wait for data in control and command connection.

=back

=head2 arcd

=over 4

=item host

Here you can specify the address the server shall wait for connections. 0 lets the server listen on all interface on the host. 

=item port

On which port the server shall listen on, can be overridden by the mentioned -p option.

=item max_requests

=item min_servers

=item max_servers

=item max_spare_servers

=item min_spare_servers

These variables define the preforking behaviour. See L<Net::Server::PreFork> 
for more detailed descriptions.

=item sasl_mechanisms

A list of the possible SASL mechanisms, the server can supply to the clients. Can be filled by using the multi-line-string method known from perl.

=back

=head2 commands

=over 4