/ 
POE-Component-Server-Syslog-1.22
River stage one • 2 direct dependents • 2 total dependents
/ POE::Component::Server::Syslog::TCP

NAME

POE::Component::Server::Syslog::TCP - syslog tcp server

VERSION

version 1.22

SYNOPSIS

POE::Component::Server::Syslog::TCP->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.

CONSTRUCTOR

spawn()

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.

Returns the POE::Session object it creates.

spawn() accepts the following options:

  • InputState

    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.

  • 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.

  • Alias

    Optionally specify that the component use the supplied alias.

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.

INPUT EVENTS

These are events that this component will accept.

register

This will register the sending session to receive InputEvent and ErrorEvents from the component.

Takes a number of parameters:

  • InputEvent

    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.

  • ErrorEvent

    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.

unregister

This will unregister the sending session from receiving events.

shutdown

Termintes the component.

AUTHOR

Matt Cashner (sungo@pobox.com)

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Matt Cashner (sungo@pobox.com).

This is free software, licensed under:

The (three-clause) BSD License