View on
MetaCPAN
Chris Williams > POE-Component-Server-Syslog > POE::Component::Server::Syslog::UDP

Download:
POE-Component-Server-Syslog-1.22.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.22   Source  

NAME ^

POE::Component::Server::Syslog::UDP - syslog udp server

VERSION ^

version 1.22

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.

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.

spawn() also accepts the following options:

InputState

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

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:

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
syntax highlighting: