root
/
telebit
mirror of https://github.com/therootcompany/telebit.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updating documentation

This commit is contained in:
Henry Camacho 2017-02-13 16:00:36 -06:00
parent 1df1e17c05
commit 82b9e7be34
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,6 +8,7 @@ Branch: restructured
* although a test project debugs just fin * although a test project debugs just fin
listener_client — the WSS client listener_client — the WSS client
--------------------------------
- removed support for anything admin - removed support for anything admin
- injected the domains from the claim - injected the domains from the claim
- domains are now included as initialDomains - domains are now included as initialDomains
@ -17,11 +18,13 @@ listener_client — the WSS client
- registration returns a true on the channel if all is well. If it is not, false. Likely will add some text to pass back. - registration returns a true on the channel if all is well. If it is not, false. Likely will add some text to pass back.
Connection Connection
----------
- added support for boolean channel - added support for boolean channel
- support for initial domains in a slice, these are brought back from the JWT as a interface and then are type asserted into the map - support for initial domains in a slice, these are brought back from the JWT as a interface and then are type asserted into the map
- removed all the old timer sender dwell stuff as a POC for traffic counts. - removed all the old timer sender dwell stuff as a POC for traffic counts.
ConnectionTable ConnectionTable
---------------
- added support for domain announcement after the WSS is connection. Not sure if we will need these. They have not been implemented. - added support for domain announcement after the WSS is connection. Not sure if we will need these. They have not been implemented.
- I assume all domains are registered with JWT unless I hear differently which would require a new WSS session - I assume all domains are registered with JWT unless I hear differently which would require a new WSS session
- expanded NewTable constructor - expanded NewTable constructor
@ -29,15 +32,18 @@ ConnectionTable
- added support for removing domains when a connection is removed. - added support for removing domains when a connection is removed.
Packer Packer
------
- added support for a PackerHeader type and PackerData type - added support for a PackerHeader type and PackerData type
- these are connected in a Packer type - these are connected in a Packer type
- support for calculated address family based on ip address property - support for calculated address family based on ip address property
- service field is set to "na" - service field is set to "na"
Logging Logging
-------
- unified package logging based on a package init. Will likely need to remove this - unified package logging based on a package init. Will likely need to remove this
Tests Tests
-----
- stared to structure project for tests. - stared to structure project for tests.