Merge pull request #101 from clue-labs/event-callbacks

clue · web-flow · commit 1823123e853b · 2017-05-03T11:10:32.000+02:00
Strict definition for event callback functions
diff --git a/README.md b/README.md
@@ -53,6 +53,13 @@ read-only streams and the readable side of duplex streams.
 Besides defining a few methods, this interface also implements the
 `EventEmitterInterface` which allows you to react to certain events.
 
+The event callback functions MUST be a valid `callable` that obeys strict
+parameter definitions and MUST accept event parameters exactly as documented.
+The event callback functions MUST NOT throw an `Exception`.
+The return value of the event callback functions will be ignored and has no
+effect, so for performance reasons you're recommended to not return any
+excessive data structures.
+
 Every implementation of this interface MUST follow these event semantics in
 order to be considered a well-behaving stream.
 
@@ -392,6 +399,13 @@ write-only streams and the writable side of duplex streams.
 Besides defining a few methods, this interface also implements the
 `EventEmitterInterface` which allows you to react to certain events.
 
+The event callback functions MUST be a valid `callable` that obeys strict
+parameter definitions and MUST accept event parameters exactly as documented.
+The event callback functions MUST NOT throw an `Exception`.
+The return value of the event callback functions will be ignored and has no
+effect, so for performance reasons you're recommended to not return any
+excessive data structures.
+
 Every implementation of this interface MUST follow these event semantics in
 order to be considered a well-behaving stream.
 
@@ -721,6 +735,13 @@ Besides defining a few methods, this interface also implements the
 `EventEmitterInterface` which allows you to react to the same events defined
 on the `ReadbleStreamInterface` and `WritableStreamInterface`.
 
+The event callback functions MUST be a valid `callable` that obeys strict
+parameter definitions and MUST accept event parameters exactly as documented.
+The event callback functions MUST NOT throw an `Exception`.
+The return value of the event callback functions will be ignored and has no
+effect, so for performance reasons you're recommended to not return any
+excessive data structures.
+
 Every implementation of this interface MUST follow these event semantics in
 order to be considered a well-behaving stream.
 
diff --git a/src/DuplexStreamInterface.php b/src/DuplexStreamInterface.php
@@ -15,6 +15,13 @@
  * `EventEmitterInterface` which allows you to react to the same events defined
  * on the `ReadbleStreamInterface` and `WritableStreamInterface`.
  *
+ * The event callback functions MUST be a valid `callable` that obeys strict
+ * parameter definitions and MUST accept event parameters exactly as documented.
+ * The event callback functions MUST NOT throw an `Exception`.
+ * The return value of the event callback functions will be ignored and has no
+ * effect, so for performance reasons you're recommended to not return any
+ * excessive data structures.
+ *
  * Every implementation of this interface MUST follow these event semantics in
  * order to be considered a well-behaving stream.
  *
diff --git a/src/ReadableStreamInterface.php b/src/ReadableStreamInterface.php
@@ -144,6 +144,13 @@
  *     non-writable AND non-readable mode, see also `isWritable()`.
  *     Note that this event should not be confused with the `end` event.
  *
+ * The event callback functions MUST be a valid `callable` that obeys strict
+ * parameter definitions and MUST accept event parameters exactly as documented.
+ * The event callback functions MUST NOT throw an `Exception`.
+ * The return value of the event callback functions will be ignored and has no
+ * effect, so for performance reasons you're recommended to not return any
+ * excessive data structures.
+ *
  * Every implementation of this interface MUST follow these event semantics in
  * order to be considered a well-behaving stream.
  *
diff --git a/src/WritableStreamInterface.php b/src/WritableStreamInterface.php
@@ -120,6 +120,13 @@
  *     non-writable AND non-readable mode, see also `isReadable()`.
  *     Note that this event should not be confused with the `end` event.
  *
+ * The event callback functions MUST be a valid `callable` that obeys strict
+ * parameter definitions and MUST accept event parameters exactly as documented.
+ * The event callback functions MUST NOT throw an `Exception`.
+ * The return value of the event callback functions will be ignored and has no
+ * effect, so for performance reasons you're recommended to not return any
+ * excessive data structures.
+ *
  * Every implementation of this interface MUST follow these event semantics in
  * order to be considered a well-behaving stream.
  *

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,13 @@`
`15`	`15`	* `EventEmitterInterface` which allows you to react to the same events defined
`16`	`16`	* on the `ReadbleStreamInterface` and `WritableStreamInterface`.
`17`	`17`	`*`
	`18`	+ * The event callback functions MUST be a valid `callable` that obeys strict
	`19`	`+ * parameter definitions and MUST accept event parameters exactly as documented.`
	`20`	+ * The event callback functions MUST NOT throw an `Exception`.
	`21`	`+ * The return value of the event callback functions will be ignored and has no`
	`22`	`+ * effect, so for performance reasons you're recommended to not return any`
	`23`	`+ * excessive data structures.`
	`24`	`+ *`
`18`	`25`	`* Every implementation of this interface MUST follow these event semantics in`
`19`	`26`	`* order to be considered a well-behaving stream.`
`20`	`27`	`*`
Original file line number	Diff line number	Diff line change
`@@ -144,6 +144,13 @@`
`144`	`144`	* non-writable AND non-readable mode, see also `isWritable()`.
`145`	`145`	* Note that this event should not be confused with the `end` event.
`146`	`146`	`*`
	`147`	+ * The event callback functions MUST be a valid `callable` that obeys strict
	`148`	`+ * parameter definitions and MUST accept event parameters exactly as documented.`
	`149`	+ * The event callback functions MUST NOT throw an `Exception`.
	`150`	`+ * The return value of the event callback functions will be ignored and has no`
	`151`	`+ * effect, so for performance reasons you're recommended to not return any`
	`152`	`+ * excessive data structures.`
	`153`	`+ *`
`147`	`154`	`* Every implementation of this interface MUST follow these event semantics in`
`148`	`155`	`* order to be considered a well-behaving stream.`
`149`	`156`	`*`
Original file line number	Diff line number	Diff line change
`@@ -120,6 +120,13 @@`
`120`	`120`	* non-writable AND non-readable mode, see also `isReadable()`.
`121`	`121`	* Note that this event should not be confused with the `end` event.
`122`	`122`	`*`
	`123`	+ * The event callback functions MUST be a valid `callable` that obeys strict
	`124`	`+ * parameter definitions and MUST accept event parameters exactly as documented.`
	`125`	+ * The event callback functions MUST NOT throw an `Exception`.
	`126`	`+ * The return value of the event callback functions will be ignored and has no`
	`127`	`+ * effect, so for performance reasons you're recommended to not return any`
	`128`	`+ * excessive data structures.`
	`129`	`+ *`
`123`	`130`	`* Every implementation of this interface MUST follow these event semantics in`
`124`	`131`	`* order to be considered a well-behaving stream.`
`125`	`132`	`*`