Casey West > poest-0.20030407 > POEST::Server

Download:
poest-0.20030407.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.3   Source  

NAME ^

POEST::Server - The Poest Master General

SYNOPSIS ^

 my $server = POEST::Server->new(
   Config     => 'POEST::Config::Genearl',
   ConfigFile => '/etc/poest.conf',
 );
 
 $server->start;

ABSTRACT ^

This module controls the server itself.

DESCRIPTION ^

All high-level server interaction happens here.

new()

Create a new server instance. This will not make the server run, but it will configure it, load the modules and configure them, and spawn the proper POE sessions. All the parameters passed to new will be passed directly to the configurator of your choice, as defined by the Config parameter (POEST::Config by default).

run()

Make the server run. This will block execution when called directly.

start()

Fork and start the server. This method will return the pid of the server. If the pidfile configuration parameter is found in the configuration class, an attempt is made to write that pid file. If that attempt fails, or if the pid file already exists, and exception is thrown and the attempt to start the server is stalled.

stop()

Stop the server. If a pidfile was specified, the pid will be read from it. Otherwise, an attempt to find a process name with the value of $0 is tried, by default that is set to 'poest'.

NOTE: As of right this minute, the process table magic isn't written as Proc::ProcessTable isn't ported to Darwin.

Configuration

Thses are the configuration parameters that the server itself needs from the configuration mechanism.

hostname

The main host that this smtp server runs for.

port

The port this server will run on.

plugin

This is a multi-value parameter. Each value is the full name of the module that contains the plugin class.

AUTHOR ^

Casey West, <casey@dyndns.org>

COPYRIGHT AND LICENSE ^

Copyright 2003 DynDNS.org

You may distribute this package under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file, with the exception that it may not be placed on physical media for distribution without the prior written approval of the author.

THIS PACKAGE IS PROVIDED WITH USEFULNESS IN MIND, BUT WITHOUT GUARANTEE OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE IT AT YOUR OWN RISK.

For more information, please visit http://opensource.dyndns.org

SEE ALSO ^

perl, POEST::Plugin, POEST::Config, POEST::Server::Commands.

syntax highlighting: