This hash element is a list of arguments the user passed in to the command. It is suggested that you assign this list to @ARGV and use Getopt::Long and friends to parse the arguments.
This hash element contains a hash of out of band data about the transaction. It is populated with hostname, appname, client_addr, and client_port.
POE::Component::ControlPort->create( local_address => 127.0.0.1, local_port => 31337, # optional... hostname => pie.pants.org, appname => my perl app, commands => \@commands, poe_debug => 1, )
The create() method in the POE::Component::ControlPort namespace is used to create and launch the control port. There are several parameters available to create().
Mandatory. The address on which the control port should listen.
Mandatory. The port on which the control port should listen.
Optional (but boring if not provided). An array of command hashes. See DEFINING COMMANDS above.
Optional. Mostly for display in the control port itself. Will probably be used for other things in the future.
Optional. The name of this application, defaulting to basename($0). This is used by TCPwrappers to determine if the connecting user is allowed to connect. This is also used as the master alias for the control port session.
The control port responds to a shutdown event to the appname given during control port creation. This event will cause the immediate shutdown of all connections and the termination of the listener.
The following perl modules are required for this module to work properly.
o Authen::Libwrap o Carp o File::Basename o POE o Params::Validate o Sys::Hostname
Matt Cashner (email@example.com)
$Rev: 266 $
$Date: 2004-05-09 22:59:17 -0400 (Sun, 09 May 2004) $
Copyright (c) 2004, Matt Cashner
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|perl v5.20.3||POE::COMPONENT::CONTROLPORT (3)||2004-05-10|