Changeset 26

Timestamp:

10/18/04 17:55:33 (4 years ago)

Author:

bradfitz

Message:

more docs, getting ready for a release

Files:

• trunk/MANIFEST (modified) (1 diff)
• trunk/META.yml (added)
• trunk/Makefile.PL (modified) (2 diffs)
• trunk/Socket.pm (modified) (1 diff)

trunk/MANIFEST

@@ -2 +2 @@
-MANIFEST
-Socket.pm
+META.yml                                 Module meta-data (added by MakeMaker)

trunk/Makefile.PL

@@ -15 +15 @@
-    NAME                    => 'Danga::Socket',
-    VERSION_FROM            => 'Socket.pm', # finds $VERSION
-Michael Granger <ge
+Brad Fitzpatrick <bra
-    ABSTRACT                => 'Async socket class',
-    PREREQ_PM               => {
@@ -25 +25 @@
-        CI                      => "cvs commit",
-        RCS_LABEL               => 'cvs tag RELEASE_$(VERSION_SYM)',
-bz2
+gz
-        DIST_DEFAULT            => 'all tardist',
-bzip2
+gzip
-    },
-

trunk/Socket.pm

@@ -3 +3 @@
-=head1 NAME
-
--driven async IO
+ loop and event-driven async socket base
-
-=head1 SYNOPSIS
-
+  package My::Socket
+  use Danga::Socket;
-  use base ('Danga::Socket');
+  use fields ('my_attribute');
+
+  sub new {
+     my My::Socket $self = shift;
+     $self = fields::new($self) unless ref $self;
+     $self->SUPER::new( @_ );
+
+     $self->{my_attribute} = 1234;
+     return $self;
+  }
+
+  sub event_err { ... }
+  sub event_hup { ... }
+  sub event_write { ... }
+  sub event_read { ... }
+  sub close { ... }
+
+  $my_sock->tcp_cork($bool);
+
+  # write returns 1 if all writes have gone through, or 0 if there
+  # are writes in queue
+  $my_sock->write($scalar);
+  $my_sock->write($scalarref);
+  $my_sock->write(sub { ... });  # run when previous data written
+  $my_sock->write(undef);        # kick-starts
+
+  # read max $bytecount bytes, or undef on connection closed
+  $scalar_ref = $my_sock->read($bytecount);
+
+  # watch for writability.  not needed with ->write().  write()
+  # will automatically turn on watch_write when you wrote too much
+  # and turn it off when done
+  $my_sock->watch_write($bool);
+
+  # watch for readability
+  $my_sock->watch_read($bool);
+
+  # if you read too much and want to push some back on
+  # readable queue.  (not incredibly well-tested)
+  $my_sock->push_back_read($buf); # scalar or scalar ref
+
+  Danga::Socket->AddOtherFds(..);
+  Danga::Socket->SetLoopTimeout(..);
+  Danga::Socket->DescriptorMap();
+  Danga::Socket->WatchedSockets();  # count of DescriptorMap keys
+  Danga::Socket->SetPostLoopCallback($code);
+  Danga::Socket->EventLoop();
-
-=head1 DESCRIPTION
-
-This is an abstract base class which provides the basic framework for
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-=cut