Document events at the top of each EventEmitter class

igorw · igorw · commit 102b1daf2b2d · 2012-12-05T17:09:29.000+01:00
diff --git a/src/React/Http/RequestHeaderParser.php b/src/React/Http/RequestHeaderParser.php
@@ -5,6 +5,7 @@
 use Evenement\EventEmitter;
 use Guzzle\Parser\Message\MessageParser;
 
+// Events: headers, error
 class RequestHeaderParser extends EventEmitter
 {
     private $buffer = '';
diff --git a/src/React/Http/Server.php b/src/React/Http/Server.php
@@ -6,11 +6,7 @@
 use React\Socket\ServerInterface as SocketServerInterface;
 use React\Socket\ConnectionInterface;
 
-/**
- * Events:
- *  * request
- *  * upgrade
- */
+// Events: request
 class Server extends EventEmitter implements ServerInterface
 {
     private $io;
diff --git a/src/React/HttpClient/Request.php b/src/React/HttpClient/Request.php
@@ -13,6 +13,7 @@
 use React\Stream\Stream;
 use React\Stream\WritableStreamInterface;
 
+// Events: headers-written, response
 class Request extends EventEmitter implements WritableStreamInterface
 {
     const STATE_INIT = 0;
diff --git a/src/React/Socket/Server.php b/src/React/Socket/Server.php
@@ -5,6 +5,7 @@
 use Evenement\EventEmitter;
 use React\EventLoop\LoopInterface;
 
+// Events: connection
 class Server extends EventEmitter implements ServerInterface
 {
     public $master;
diff --git a/src/React/Socket/ServerInterface.php b/src/React/Socket/ServerInterface.php
@@ -4,6 +4,7 @@
 
 use Evenement\EventEmitterInterface;
 
+// Events: connection
 interface ServerInterface extends EventEmitterInterface
 {
     public function listen($port, $host = '127.0.0.1');
diff --git a/src/React/Stream/Buffer.php b/src/React/Stream/Buffer.php
@@ -6,6 +6,7 @@
 use React\EventLoop\LoopInterface;
 use React\Stream\WritableStreamInterface;
 
+// Events: full-drain
 class Buffer extends EventEmitter implements WritableStreamInterface
 {
     public $stream;

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use Evenement\EventEmitter;`
`6`	`6`	`use Guzzle\Parser\Message\MessageParser;`
`7`	`7`
	`8`	`+// Events: headers, error`
`8`	`9`	`class RequestHeaderParser extends EventEmitter`
`9`	`10`	`{`
`10`	`11`	`private $buffer = '';`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`use React\Stream\Stream;`
`14`	`14`	`use React\Stream\WritableStreamInterface;`
`15`	`15`
	`16`	`+// Events: headers-written, response`
`16`	`17`	`class Request extends EventEmitter implements WritableStreamInterface`
`17`	`18`	`{`
`18`	`19`	`const STATE_INIT = 0;`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use Evenement\EventEmitter;`
`6`	`6`	`use React\EventLoop\LoopInterface;`
`7`	`7`
	`8`	`+// Events: connection`
`8`	`9`	`class Server extends EventEmitter implements ServerInterface`
`9`	`10`	`{`
`10`	`11`	`public $master;`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Evenement\EventEmitterInterface;`
`6`	`6`
	`7`	`+// Events: connection`
`7`	`8`	`interface ServerInterface extends EventEmitterInterface`
`8`	`9`	`{`
`9`	`10`	`public function listen($port, $host = '127.0.0.1');`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`use React\EventLoop\LoopInterface;`
`7`	`7`	`use React\Stream\WritableStreamInterface;`
`8`	`8`
	`9`	`+// Events: full-drain`
`9`	`10`	`class Buffer extends EventEmitter implements WritableStreamInterface`
`10`	`11`	`{`
`11`	`12`	`public $stream;`