POE::Component::Server::Syslog::UDP
POE::Component::Server::Syslog::UDP->spawn(
BindAddress => '127.0.0.1',
BindPort => '514',
InputState => \&input,
);
sub input {
my $message = $_[ARG0];
# .. do stuff ..
}
This component provides very simple syslog services for POE.
Spawns a new listener. For a standalone syslog server you may specify InputState option to register a subroutine that will be called on input events.
For integration with other POE Sessions and Components you may use the register and unregister states to request that input events be sent to your sessions.
spawn() also accepts the following options:
A reference to a subroutine. This argument will become a POE state that will be called when input from a syslog client has been recieved.
The address to bind the listener to. Defaults to 0.0.0.0
The port number to bind the listener to. Defaults to 514
The maximum length of a datagram. Defaults to 1024, which is the usual default of most syslog and syslogd implementations.
An optional code reference. This becomes a POE state that will get called when the component recieves a message it cannot parse. The erroneous message is passed in as ARG0.
Optionally specify that the component use the supplied alias.
The ClientInput routine obtained by spawn() will be passed a hash reference as ARG0 containing the following information:
The time of the datagram (as specified by the datagram itself)
The priority of message.
The "facility" number decoded from the pri.
The "severity" number decoded from the pri.
The remote address of the source in dotted-decimal notation.
The hostname of the source, if available.
The message itself. This often includes a process name, pid number, and user name.
These are events that this component will accept.
This will register the sending session to receive InputEvent and ErrorEvents from the component.
Takes a number of parameters:
Mandatory parameter, the name of the event in the registering session that will be triggered for input from clients. ARG0 will contain a hash reference. See InputHandler for details.
Optional parameter, the name of the event in the registering session that will be triggered for input that cannot be parsed. ARG0 will contain the erroneous message.
The component will increment the refcount of the calling session to make sure it hangs around for events. Therefore, you should use either unregister or shutdown to terminate registered sessions.
This will unregister the sending session from receiving events.
Termintes the component.
$Date: 2004-12-26 20:37:33 -0500 (Sun, 26 Dec 2004) $
$Rev: 449 $
Note: This does not necessarily correspond to the distribution version number.
Matt Cashner (sungo@cpan.org)
Copyright (c) 2003-2004, Matt Cashner. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR CONTRIBUTORS 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.
