Kevin L. Esteb > XAS-0.04 > XAS::Lib::Net::Server

Download:
XAS-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source   Latest Release: XAS-0.07

NAME ^

XAS::Lib::Net::Server - A basic network server for the XAS Environment

SYNOPSIS ^

 my $server = XAS::Lib::Net::Server->new(
     -port             => 9505,
     -address          => 'localhost',
     -filter           => POE::Filter::Line->new(),
     -alias            => 'server',
     -inactivity_timer => 600
 }

DESCRIPTION ^

This module implements a simple text orientated nework protocol. All "packets" will have an explict "\012\015" appended. These packets may be formated strings, such as JSON. The server runs as a POE session.

METHODS ^

new

This initializes the module and starts listening for requests. There are five parameters that can be passed. They are the following:

-alias

The name of the POE session.

-port

The IP port to listen on.

-address

The address to bind too.

-inactivty_timer

Sets an inactivity timer on clients. When it is surpassed, the method reaper() is called with the POE wheel id. What reaper() does is application specific. The default is 600 seconds.

-filter

An optional filter to use, defaults to POE::Filter::Line

initialize($kernel)

This method is for specific initialization of the module. By default it does nothing.

$kernel

A handle for the POE kernel

reload($kernel, $session)

This method runs when a HUP signal is recieved. By default if does nothing.

$kernel

A handle for the POE kernel.

$session

A handle to the current POE session.

shutdown($kernel, $session)

This method starts the "shutdown" process for the POE session. A "shutdown" can be initiated by an INT, TERM or QUIT signal. By default it does nothing.

$kernel

A handle to the POE kernel.

$session

A handle to the current POE session.

reaper($wheel)

Called when the inactivity timer is triggered.

$wheel

The POE wheel that triggered the timer.

process($packet, $wheel)

This method does the processing for any packets that are sent over the socket. By default, it just returns the packet.

$packet

The packet that was sent over the socket.

$wheel

The POE wheel that handled the packet.

log($level, $message)

This will write log messages. The default this is just a dump to stderr.

$level

The log level, this is usually INFO, WARN, ERROR, FATAL or DEBUG. These are the levels that are understood by the XAS logger.

$message

The message to log.

ACCESSORS ^

peerport($wheel)

This returns the current port for that wheel.

$wheel

The POE wheel to use.

host($wheel)

This returns the current hostname for that wheel.

$wheel

The POE wheel to use.

client($wheel)

This returns the current client for that wheel.

$wheel

The POE wheel to use.

SEE ALSO ^

 POE::Filter::Line

XAS

AUTHOR ^

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: