The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
POE-Component-Server-Syslog-1.00
River stage one • 2 direct dependents • 2 total dependents
/ POE::Component::Server::Syslog::UDP

NAME

POE::Component::Server::Syslog::UDP

SYNOPSIS

    POE::Component::Server::Syslog::UDP->spawn(
        BindAddress => '127.0.0.1',
        BindPort    => '514',
        InputState  => \&input,
    );

    sub input {
        my $message = $_[ARG0];
        # .. do stuff ..
    }

DESCRIPTION

This component provides very simple syslog services for POE.

METHODS

spawn()

Spawns a new listener. Requires one argument, InputState, which must be 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. Returns the POE::Session object it creates.

spawn() also accepts the following options:

  • BindAddress

    The address to bind the listener to. Defaults to 0.0.0.0

  • BindPort

    The port number to bind the listener to. Defaults to 514

  • MaxLen

    The maximum length of a datagram. Defaults to 1024, which is the usual default of most syslog and syslogd implementations.

  • ErrorState

    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.

InputState

The ClientInput routine obtained by spawn() will be passed a hash reference as ARG0 containing the following information:

  • time

    The time of the datagram (as specified by the datagram itself)

  • pri

    The priority of message.

  • facility

    The "facility" number decoded from the pri.

  • severity

    The "severity" number decoded from the pri.

  • host

    The host that sent the message.

  • msg

    The message itself. This often includes a process name, pid number, and user name.

DATE

$Date: 2004-12-26 20:37:33 -0500 (Sun, 26 Dec 2004) $

REVISION

$Rev: 449 $

Note: This does not necessarily correspond to the distribution version number.

AUTHOR

Matt Cashner (sungo@cpan.org)

LICENSE

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:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the Matt Cashner nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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.