rxio 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e88bca529897026801d80d9d4d95b91d0a5f1dc
-  data.tar.gz: 06e650d5f38c807dfa101a0271f29e008fd00af0
+  metadata.gz: 228708ecd79c1afb5bd62da4683bef150cf50c6a
+  data.tar.gz: 0c66ec5a480f2b2fefee570fa4e0b75167891b71
 SHA512:
-  metadata.gz: '0219070ef83bc245d694c0c21f2508dd84383f669931267f4c82b3e3652c3e1527b135966eb01fe882f7d7090258d4954c622b082308c282b5772d1fbfb2c047'
-  data.tar.gz: c1d3963b76522bf85cfb65c7a34ffc9869af091e85117496b41fcf345136dbfefe6ca2554ba8ff58386fd37937b30dbb883a3629eb3d659c299a79e0a2312646
+  metadata.gz: 5cc47f04fb679e4155bf0224cc0f26ecbb30ff5c4bee7ef166175a9bdf1a808e70dac48d79543231c693b56578162a8f125cec048a63b9d632e77e7d332860af
+  data.tar.gz: b303e51ca173458e430f85bccea0249965836eb2aa9236bbbe0835f0456aeb8233e8bba1c3f8766d6d686ba52e0e9e06f8b9039e336fd483a104d5dd34f9f53a

data/README.md

@@ -133,6 +133,16 @@ Note: this method does not perform any encoding or transformation on the data. I
 
 Used to add a data chunk to the endpoint's input buffer.
 
+### The Peer Hash
+
+Most of RxIO works around a *peer hash*, which is used to represent information about a remote peer.
+This hash is built by RxIO when connecting to a service, or when accepting a client's connection request.
+
+The hash contains a lot of information but only two elements are really important for the user:
+
+* :peer - A hash containing *name*, *addr*, and *port* of the remote peer
+* :local - A reference to the Service / Client instance on the *local* end.
+
 ### Dropping Clients
 
 To properly drop a client (ensuring that any buffered data is flushed out), simply set its *:drop* attribute to anything truthy:

data/lib/rxio/version.rb

@@ -5,5 +5,5 @@
 module RxIO
 
 	# Version
-	VERSION = '1.2.9'
+	VERSION = '1.2.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rxio
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Eresse