Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
HTTP::Server::Simple::UsernContributed Perl DocuHTTP::Server::Simple::Mason(3)

NAME
       HTTP::Server::Simple::Mason - An	abstract baseclass for a standalone
       mason server

SYNOPSIS
	       my $server = MyApp::Server->new();

	       $server->run;

	       package MyApp::Server;
	       use base	qw/HTTP::Server::Simple::Mason/;

	       sub mason_config	{
		   return ( comp_root => '/tmp/mason-pages' );
	       }

DESCRIPTION
INTERFACE
       See HTTP::Server::Simple	and the	documentation below.

   mason_handler
       Returns the server's "HTML::Mason::CGIHandler" object.  The first time
       this method is called, it creates a new handler by calling
       "new_handler".

   handle_request CGI
       Called with a CGI object. Invokes mason and runs	the request

   handle_error	ERROR
       If the call to "handle_request" dies, "handle_error" is called with the
       exception (that is, $@).	 By default, it	does nothing; it can be
       overriden by your subclass.

   new_handler
       Creates and returns a new "HTML::Mason::CGIHandler", with configuration
       specified by the	"default_mason_config" and "mason_config" methods.
       You don't need to call this method yourself; "mason_handler" will
       automatically call it the first time it is called.

   handler_class
       Returns the name	of the Mason handler class invoked in "new_handler".
       Defaults	to HTML::Mason::CGIHandler, but	in your	subclass you may wish
       to change it to a subclass of HTML::Mason::CGIHandler.

   setup_escapes $handler
       Sets up the Mason escapes for the handler $handler.  For	example, the
       "h" in

	 <% $name | h %>

       By default, sets	"h" to "HTTP::Server::Simple::Mason::escape_utf8" and
       "u" to "HTTP::Server::Simple::Mason::escape_uri", but you can override
       this in your subclass.

   mason_config
       Returns a subclass-defined mason	handler	configuration; you almost
       certainly want to override it and specify at least "comp_root".

   default_mason_config
       Returns the default mason handler configuration (which can be
       overridden by entries in	"mason_config").

   escape_utf8 SCALARREF
       does a css-busting but minimalist escaping of whatever html you're
       passing in.

   escape_uri SCALARREF
       Escapes URI component according to RFC2396

CONFIGURATION AND ENVIRONMENT
       For most	configuration, see HTTP::Server::Simple.

       You can (and must) configure your mason CGI handler by subclassing this
       module and overriding the subroutine "mason_config". It's most
       important that you set a	component root (where your pages live) by
       adding

	   comp_root =>	'/some/absolute/path'

       See the Synopsis	section	or "ex/sample_server.pl" in the	distribution
       for a complete example.

DEPENDENCIES
       HTTP::Server::Simple HTML::Mason

INCOMPATIBILITIES
       None reported.

BUGS AND LIMITATIONS
       Please report any bugs or feature requests to
       "bug-http-server-simple-mason@rt.cpan.org", or through the web
       interface at <http://rt.cpan.org>.

AUTHOR
       Jesse Vincent "<jesse@bestpractical.com>"

LICENCE	AND COPYRIGHT
       Copyright (c) 2001-2005,	Jesse Vincent  "<jesse@bestpractical.com>".
       All rights reserved.

       This module is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS	LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE	EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN	WRITING	THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS	IS" WITHOUT WARRANTY OF	ANY KIND,
       EITHER EXPRESSED	OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF	THE SOFTWARE IS	WITH
       YOU. SHOULD THE SOFTWARE	PROVE DEFECTIVE, YOU ASSUME THE	COST OF	ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR	AGREED TO IN WRITING
       WILL ANY	COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE	SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE	USE OR INABILITY TO USE	THE
       SOFTWARE	(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED	INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.32.0			  2010-09-05	HTTP::Server::Simple::Mason(3)

NAME | SYNOPSIS | DESCRIPTION | INTERFACE | CONFIGURATION AND ENVIRONMENT | DEPENDENCIES | INCOMPATIBILITIES | BUGS AND LIMITATIONS | AUTHOR | LICENCE AND COPYRIGHT | DISCLAIMER OF WARRANTY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=HTTP::Server::Simple::Mason&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help