Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 251 lines (187 sloc) 7.991 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
$Id$

-----------
What POE Is
-----------

POE is an application kernel that uses event driven state machines as
threads. It includes a high-level I/O library that hides most of the
usual client/server tediosity. It has been developed and used in
mission-critical systems since August 1998.

---------------------
Documentation Roadmap
---------------------

The POE manpage's SEE ALSO section lists the topics covered in each
manpage. It's a good starting place.

------------------
Basic Installation
------------------

POE may be installed through the CPAN shell in the usual CPAN shell
manner. It typically is:

  perl -MCPAN -e 'install POE'

It involves a little more work if you have an older CPAN shell:

  perl -MCPAN -e shell
  install POE

--------------------------
Getting The Latest Version
--------------------------

POE can also be installed manually. Tarballs are available from at
least three sources:

The most recent stable release can be found at your favorite CPAN
mirror. If you don't have a favorite CPAN mirror, there's always:

  ftp://ftp.cpan.org/pub/CPAN/authors/id/R/RC/RCAPUTO/

The most recent development snapshot is available from two locations:

  http://poe.perl.org/
  http://sourceforge.net/projects/poe/

The SourceForge project includes a CVS repository browser, so you can
look around to see what's new. It also has facilities for people to
submit bug reports, patches, and support requests.

---------------------------
Building The Latest Version
---------------------------

Downloading and unpacking the distribution are left as an exercise for
the reader. See the previous section for tarball locations.

System requirements and copatibility issues are covered in the main
POE manpage. You can preview them before building POE.

  perldoc ./POE.pm

Please read the Changes file if you already have programs which use
POE. Sometimes there are changes that break compatibility with older
versions, and the Changes file can tell you about them before you
install POE.

  less ./Changes

If everything looks good, build POE.

  perl Makefile.PL
  make

Then test the distribution. This is an important step since it also
ferrets out the modules POE needs. It reports on the POE components
which won't work because of missing dependencies, and it recommends
things to install. Please read the dependency report carefully.

  make test

Now you're ready to install POE, but first you may want to look at its
samples. Some of the samples may not work; the important thing is
that the tests pass. All the programs in the samples subdirectory are
written to run from the distribution directory without POE being
installed yet.

  cd ./samples
  ls -l

  [try some]

  cd ..

Finally you can install it:

  make install

--------------------
Distribution Details
--------------------

This distribution comes with several sample and tutorial programs in
its samples/ directory. These programs are NOT installed because they
have limited use and take up a lot of space and have limited use.
They will be split into a separate distribution in the near future.

The lib/ directory includes a few useful utilities, including a
relatively portable bidirectional pipe creator. There's also a small
test coverage module, harness, and report. The test coverage summary
at the end of this file was generated by that system. These utilities
aren't installed either.

The test programs, in t/, may also be interesting examples, although
they're more geared towards exercising POE. The tests also aren't
installed.

All in all, the actual installed bits of POE are probably around a
third of the total distribution, and about a quarter of B<that> is
documentation.

------------
Test Results
------------

All the tests have been made to run unattended, and testing has been
automated across the systems.

** POE 0.1205 on OS/2 (home-os2)

OS/2 doesn't grok system vs. user time, so the numbers are 0.

Hardware: Cyrix P166+; 64MB RAM
System : OS/2 4.0, Fix 13
Perl : v5.6.0
Gtk : (not installed)
Tk : (not installed)
Event : (not installed)
IO::Pty : 0.01

All tests successful, 4 tests and 5 subtests skipped.
Files=24, Tests=429, 148 wallclock secs ( 0.00 cusr + 0.00 csys = 0.00 CPU)

** POE 0.1205 on FreeBSD (home-bsd)

Hardware: AMD 486-40; 16MB RAM
System : FreeBSD 4.0-STABLE
Perl : v5.6.0
Gtk : 0.7004
Tk : 800.021
Event : 0.79
IO::Pty : 0.01

All tests successful.
Files=24, Tests=455, 684 wallclock secs (425.65 cusr + 36.95 csys = 462.60 CPU)

** POE 0.1205 on Linux (titanic)

Hardware: dual Celeron 500; 265MB RAM
System : Linux 2.2.15 SMP
Perl : v5.6.0
Gtk : (not installed)
Tk : (not installed)
Event : 0.79
IO::Pty : 0.01

All tests successful, 2 tests skipped.
Files=24, Tests=438, 106 wallclock secs (22.53 cusr + 0.84 csys = 23.37 CPU)

** POE 0.1205 on Solaris/SunOS 5.7 (hfb)

Hardware: SPARCstation-20; dual Sparc-75; 320MB RAM
System : SunOS 5.7
Perl : 5.005_03
Gtk : (not installed)
Tk : (not installed)
Event : (not installed)
IO::Pty : 0.01

All tests successful, 4 tests skipped.
Files=24, Tests=429, 122 wallclock secs (61.70 cusr + 5.49 csys = 67.19 CPU)

** POE 0.1203 on Linux (a-mused)

Hardware: Celeron 600; unknown RAM
System : Linux 2.4.0-test12
Perl : 5.005_03
Gtk : (unknown)
Tk : (not installed)
Event : (installed; unknown version)

All tests successful, 2 tests skipped.
Files=23, Tests=415, 98 wallclock secs (14.22 cusr + 0.63 csys = 14.85 CPU)

** POE 0.1203 on Solaris/SunOS 5.8 (dynweb)

Hardware: SPARCstation-80; 2x UltraSparc II-450; 1GB RAM
System : SunOS 5.7
Perl : 5.6.0
Gtk : (not installed)
Tk : (not installed)
Event : 0.80

All tests successful, 2 tests skipped.
Files=23, Tests=415, 98 wallclock secs (14.03 cusr + 0.99 csys = 15.02 CPU)

-------------
Test Coverage
-------------

The test coverage numbers are statistically meaningless. Still, 100%
coverage is a fun goal. Increasing the coverage percents gives the
author some small sense of accomplishment, and it assures users that
something's being done to assure POE's quality.

These results are for POE 0.1205 on the FreeBSD test machine. This
machine is the slowest of the bunch, but it also has the most support
libraries installed.

  Source File = Ran / Total = Covered
  POE.pm = 23 / 24 = 95.83%
  POE/Component.pm = 5 / 5 = 100.00%
  POE/Component/Server/TCP.pm = 26 / 26 = 100.00%
  POE/Driver.pm = 5 / 5 = 100.00%
  POE/Driver/SysRW.pm = 42 / 54 = 77.78%
  POE/Filter.pm = 5 / 5 = 100.00%
  POE/Filter/Block.pm = 37 / 37 = 100.00%
  POE/Filter/HTTPD.pm = 11 / 88 = 12.50%
  POE/Filter/Line.pm = 77 / 82 = 93.90%
  POE/Filter/Reference.pm = 60 / 66 = 90.91%
  POE/Filter/Stream.pm = 11 / 11 = 100.00%
  POE/Kernel.pm = 572 / 815 = 70.18%
  POE/NFA.pm = 74 / 157 = 47.13%
  POE/Pipe/OneWay.pm = 20 / 39 = 51.28%
  POE/Pipe/TwoWay.pm = 23 / 43 = 53.49%
  POE/Preprocessor.pm = 147 / 167 = 88.02%
  POE/Session.pm = 126 / 181 = 69.61%
  POE/Wheel.pm = 11 / 11 = 100.00%
  POE/Wheel/FollowTail.pm = 75 / 96 = 78.12%
  POE/Wheel/ListenAccept.pm = 39 / 53 = 73.58%
  POE/Wheel/ReadWrite.pm = 111 / 188 = 59.04%
  POE/Wheel/Run.pm = 141 / 239 = 59.00%
  POE/Wheel/SocketFactory.pm = 197 / 234 = 84.19%
  All Told = 1838 / 2626 = 69.99%

Thanks for reading!

-- Rocco Caputo / troc@netrus.net / poe.perl.org / poe.sourceforge.net
Something went wrong with that request. Please try again.