NAME

IO::Socket::INET::Host - very simple straightforward TCP server

SYNOPSIS

use IO::Socket::INET::Host;

my $host = new IO::Socket::INET::Host(
	port => 5000,
	timeout => 20,
	callback => {
		add => \&add,
		remove => \&remove,
		data => \&data,
	},
);

$host->run;

sub add {
	my $io = shift;

	$io->print("Welcome, ", $io->peerhost, ".\n";

	return !0;
}

sub remove {
	my $io = shift;

	warn $io->peerhost, " left.\n";
}

sub data {
	my $io = shift;

	my $line = $io->getline;
	
	$line =~ s/\r?\n//;

	if($line eq 'quit') {
		$io->print("Bye.\n");
		return 0;
	}
	else {
		$io->print("You wrote: $line\n");
		return !0;
	}
}

DESCRIPTION

This modules aims to provide a simple TCP server. It will listen on a port you specify, accept incoming connections and remove them again when they're dead. It provides three simple callbacks at the moment, but I plan to add a few more.

METHODS

new(...)

This is the constructor. It takes all the information the server needs as parameter. Currently, the following options are supported.

port

The port to listen on.

host

The host to bind to (hostname or IP).

timeout

The time to wait for actions in seconds. This is simply passed to IO::Select.

callback

A reference to a hash with function references assigned to callback names. Currently, three callbacks are supported. "add" is called when a new connection was accepted. If it returns a false value, the connection is kicked again right away. "remove" is called when a connection got lost. "data" is called when there's pending data on a connection. If the callback function returns false, the connection is removed afterwards. All callbacks are called with the peer socket as argument (IO::Socket::INET).

callback(add => \&add, remove => \&remove, data => \&data)

This method overwrites callbacks set up with the constructor.

run(no parameters at all)

Enter the main loop. Won't ever return.

BUGS

This module was hacked together within a few minutes, so there are probably lots of bugs. On the other hand, it's very few code, so there can't be that much bugs in it. Just try it out and tell me if it's broken.

TODO

  • Add tests to the package.

  • Add a "tick" callback that is called after every cycle (for maintenance tasks).

  • ...

COPYRIGHT

Copyright (C) 2008 by Jonas Kramer <jkramer@cpan.org>. Published under the terms of the Artistic License 2.0.