Chris Williams > POE-Component-Server-Syslog > POE::Component::Server::Syslog::TCP

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

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.20   Source  

NAME ^

POE::Component::Server::Syslog::TCP

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

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.

DATE ^

$Date: 2004-12-26 19:57:57 -0500 (Sun, 26 Dec 2004) $

REVISION ^

$Rev: 446 $

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:

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.

syntax highlighting: