]> git.mxchange.org Git - hub.git/blobdiff - docs/TODOs.txt
Documentation section added for 'chat console'
[hub.git] / docs / TODOs.txt
index 58dfcd9b6dbfe2f91c26cf104990516561ac4c82..0c067a8666811a15a4de5c63fca37f1903410a6a 100644 (file)
@@ -1,17 +1,19 @@
 ### WARNING: THIS FILE IS AUTO-GENERATED BY ./todo-builder.sh ###
 ### DO NOT EDIT THIS FILE. ###
 ./application/hub/interfaces/cruncher/class_CruncherHelper.php:10: * @todo             We need to find a better name for this interface
+./application/hub/interfaces/helper/connections/class_ConnectionHelper.php:44:  * @todo        We may want to implement a filter for ease notification of other objects like our pool
 ./application/hub/interfaces/nodes/class_NodeHelper.php:10: * @todo            We need to find a better name for this interface
-./application/hub/main/commands/console/class_HubConsoleCruncherCommand.php:104:        * @todo        Should we add some more filters?
+./application/hub/main/commands/console/class_HubConsoleCruncherCommand.php:107:        * @todo        Should we add some more filters?
 ./application/hub/main/commands/console/class_HubConsoleCruncherCommand.php:58:         * @todo        Try to create a CruncherActivationTask or so
 ./application/hub/main/commands/console/class_HubConsoleMainCommand.php:114:    * @todo        Should we add some more filters?
 ./application/hub/main/commands/console/class_HubConsoleMainCommand.php:58:     * @todo        Try to create a HubActivationTask or so
 ./application/hub/main/connectors/query/local/class_LocalQueryConnector.php:10: * @todo                Find an interface for: handleAllQueries()
 ./application/hub/main/connectors/query/local/class_LocalQueryConnector.php:78:         * @TODO        0% done: Unfinished work here
 ./application/hub/main/connectors/queues/local/class_LocalQueueConnector.php:58:        * @TODO        0% done: Unfinished work here
-./application/hub/main/cruncher/class_BaseHubCruncher.php:175:  * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
-./application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php:128:         * @todo        0% done
-./application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php:98:  * @todo        Implement this method
+./application/hub/main/cruncher/class_BaseHubCruncher.php:188:  * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
+./application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php:108:         * @todo        Implement this method
+./application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php:138:         * @todo        0% done
+./application/hub/main/cruncher/mcrypt/class_HubMcryptCruncher.php:98:         // @TODO Implement this method
 ./application/hub/main/discovery/socket/class_PackageSocketDiscovery.php:102:                  // @TODO We may need some locking here
 ./application/hub/main/factories/socket/class_SocketFactory.php:10: * @todo            Find an interface for hub helper
 ./application/hub/main/filter/bootstrap/cruncher/class_CruncherBootstrapBufferQueueInitializerFilter.php:54:    * @todo        0% done
 ./application/hub/main/filter/shutdown/node/class_NodeShutdownTaskHandlerFilter.php:55:         * @todo        0% done
 ./application/hub/main/filter/task/cruncher/class_CruncherTaskHandlerInitializerFilter.php:55:  * @todo        5% done
 ./application/hub/main/filter/task/node/class_NodeTaskHandlerInitializerFilter.php:55:  * @todo        Maybe some more tasks needs to be added?
-./application/hub/main/handler/network/tcp/class_TcpNetworkPackageHandler.php:96:       * @todo        ~10% done
-./application/hub/main/handler/network/udp/class_UdpNetworkPackageHandler.php:58:       * @todo        0%
+./application/hub/main/handler/network/class_BaseRawDataHandler.php:142:        * @todo        This method will be moved to a better place
+./application/hub/main/handler/network/class_BaseRawDataHandler.php:149:               // @TODO Numeric or alpha-numeric index?
+./application/hub/main/handler/network/udp/class_UdpRawDataHandler.php:58:      * @todo        0%
 ./application/hub/main/handler/tasks/class_TaskHandler.php:140:                // @TODO Messurement can be added around this call
 ./application/hub/main/helper/connection/tcp/class_TcpConnectionHelper.php:10: * @todo         Find an interface for hub helper
-./application/hub/main/helper/connection/tcp/class_TcpConnectionHelper.php:139:         * @todo        We may want to implement a filter for ease notification of other objects like our pool
+./application/hub/main/helper/connection/tcp/class_TcpConnectionHelper.php:141:         * @todo        We may want to implement a filter for ease notification of other objects like our pool
 ./application/hub/main/helper/connection/udp/class_UdpConnectionHelper.php:10: * @todo         Find an interface for hub helper
+./application/hub/main/helper/connection/udp/class_UdpConnectionHelper.php:54:  * @todo        We may want to implement a filter for ease notification of other objects like our pool
 ./application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php:10: * @todo               Find an interface for hub helper
-./application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php:65:        * @todo        Rewrite the ->renderXmlContent() call to no arguments
+./application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php:61:        * @todo        Rewrite the ->renderXmlContent() call to no arguments
 ./application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php:10: * @todo                Find an interface for hub helper
 ./application/hub/main/helper/work_units/cruncher/class_CruncherTestUnitHelper.php:53:  * @todo        0% done
 ./application/hub/main/helper/work_units/cruncher/class_CruncherTestUnitHelper.php:64:  * @todo        0% done
 ./application/hub/main/iterator/network/class_NetworkListenIterator.php:11: * @todo            latency-based iteration or similar approaches
 ./application/hub/main/iterator/pool/handler/class_HandlerPoolIterator.php:10: * @todo         This current implementation is not recommended, use a
 ./application/hub/main/iterator/pool/handler/class_HandlerPoolIterator.php:11: * @todo         latency-based iteration or similar approaches
+./application/hub/main/iterator/pool/monitor/class_MonitorPoolIterator.php:10: * @todo         This current implementation is not recommended, use a
+./application/hub/main/iterator/pool/monitor/class_MonitorPoolIterator.php:11: * @todo         latency-based iteration or similar approaches
 ./application/hub/main/iterator/pool/tasks/class_TaskPoolIterator.php:10: * @todo              This current implementation is not recommended, use a
 ./application/hub/main/iterator/pool/tasks/class_TaskPoolIterator.php:11: * @todo              latency-based iteration or similar approaches
-./application/hub/main/listener/udp/class_UdpListener.php:133:  * @todo        ~50% done
+./application/hub/main/listener/udp/class_UdpListener.php:139:  * @todo        ~50% done
 ./application/hub/main/lists/class_BaseList.php:264:                   // @TODO Extend this somehow?
+./application/hub/main/lists/groups/class_ListGroupList.php:52:         * @todo        0% done
+./application/hub/main/lists/hub/class_HubList.php:56:  * @todo0% done
+./application/hub/main/lists/recipient/class_RecipientList.php:59:      * @todo0% done
+./application/hub/main/lists/tasks/class_TaskList.php:55:       * @todo0% done
 ./application/hub/main/nodes/boot/class_HubBootNode.php:119:           // @TODO Add some filters here
 ./application/hub/main/nodes/boot/class_HubBootNode.php:58:     * @todo        add some more special bootstrap things for this boot node
 ./application/hub/main/nodes/boot/class_HubBootNode.php:99:     * @todo        Unfinished method
-./application/hub/main/nodes/class_BaseHubNode.php:452:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
-./application/hub/main/nodes/class_BaseHubNode.php:492:         * @todo        Change the first if() block to check for a specific state
-./application/hub/main/nodes/class_BaseHubNode.php:667:                // @TODO Add some criteria, e.g. if the node is active or so
+./application/hub/main/nodes/class_BaseHubNode.php:382:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
+./application/hub/main/nodes/class_BaseHubNode.php:422:         * @todo        Change the first if() block to check for a specific state
+./application/hub/main/nodes/class_BaseHubNode.php:595:                // @TODO Add some criteria, e.g. if the node is active or so
 ./application/hub/main/nodes/list/class_HubListNode.php:58:     * @todo        Implement more bootstrap steps
 ./application/hub/main/nodes/list/class_HubListNode.php:68:     * @todo        Unfinished method
 ./application/hub/main/nodes/list/class_HubListNode.php:91:            // @TODO Add some filters here
 ./application/hub/main/nodes/regular/class_HubRegularNode.php:58:       * @todo        Implement this method
 ./application/hub/main/nodes/regular/class_HubRegularNode.php:68:       * @todo        Unfinished method
 ./application/hub/main/nodes/regular/class_HubRegularNode.php:91:              // @TODO Add some filters here
-./application/hub/main/package/class_NetworkPackage.php:150:           // @TODO crc32 is not good, but it needs to be fast
-./application/hub/main/package/class_NetworkPackage.php:22: * @todo            Needs to add functionality for handling the object's type
-./application/hub/main/package/class_NetworkPackage.php:259:                   // @TODO We may want to do somthing more here?
-./application/hub/main/package/class_NetworkPackage.php:357:                   // @TODO Add some logging here
-./application/hub/main/package/class_NetworkPackage.php:383:                   // @TODO Add some logging here
-./application/hub/main/package/class_NetworkPackage.php:409:                   // @TODO Add some logging here
+./application/hub/main/package/class_NetworkPackage.php:210:    * @todo        $helperInstance is unused
+./application/hub/main/package/class_NetworkPackage.php:214:           // @TODO crc32 is not very strong, but it needs to be fast
+./application/hub/main/package/class_NetworkPackage.php:23: * @todo            Needs to add functionality for handling the object's type
+./application/hub/main/package/class_NetworkPackage.php:330:                   // @TODO We may want to do somthing more here?
+./application/hub/main/package/class_NetworkPackage.php:429:                   // @TODO Add some logging here
+./application/hub/main/package/class_NetworkPackage.php:455:                   // @TODO Add some logging here
+./application/hub/main/package/class_NetworkPackage.php:548:                   // @TODO Add some logging here
+./application/hub/main/package/class_NetworkPackage.php:626:           // @TODO Add some content here
+./application/hub/main/package/fragmenter/class_PackageFragmenter.php:426:      * @todo        $connectionInstance is unused
 ./application/hub/main/pools/peer/class_DefaultPeerPool.php:148:                       // @TODO Check for IP
-./application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php:127:                            // @TODO Do something with it
-./application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php:78:      * @todo        ~30% done
-./application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php:98:                     // @TODO Unfinished work here
+./application/hub/main/producer/cruncher/keys/class_CruncherKeyProducer.php:106:                       // @TODO Do something with it
+./application/hub/main/producer/cruncher/keys/class_CruncherKeyProducer.php:62:         * @todo        Find something for init phase of this key producer
+./application/hub/main/producer/cruncher/keys/class_CruncherKeyProducer.php:72:         * @todo        ~30% done
+./application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php:79:      * @todo        ~60% done
+./application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php:99:                     // @TODO Unfinished work here
 ./application/hub/main/resolver/state/network/class_NetworkStateResolver.php:68:        * @todo        ~30% done
 ./application/hub/main/resolver/state/network/class_NetworkStateResolver.php:80:                       // @TODO On some systems it is 134, on some 107?
+./application/hub/main/states/node/init/class_NodeInitState.php:63:     * @todo        We might want to move some calls to this method to fill it with life
+./application/hub/main/streams/raw_data/input/class_RawDataInputStream.php:57:  * @todo        Do we need to do something more here?
+./application/hub/main/streams/raw_data/output/class_RawDataOutputStream.php:53:        * @todo        Do we need to do something more here?
+./application/hub/main/tasks/cruncher/class_CruncherKeyProducerTask.php:53:     * @todo        Maybe visit some sub-objects
 ./application/hub/main/tasks/cruncher/class_CruncherTestUnitProducerTask.php:53:        * @todo        Maybe visit some sub-objects
-./application/hub/main/tasks/cruncher/class_CruncherTestUnitProducerTask.php:64:        * @todo        0%
 ./application/hub/main/tasks/cruncher/class_CruncherWorkUnitFetcherTask.php:54:         * @todo        Maybe visit some sub-objects
 ./application/hub/main/tasks/hub/announcement/class_HubSelfAnnouncementTask.php:53:     * @todo        0%
 ./application/hub/main/tasks/hub/class_HubSelfConnectTask.php:53:       * @todo        0%
+./application/hub/main/tasks/hub/class_HubSocketListenerTask.php:62:           // @TODO Do we need to visit this task? $visitorInstance->visitTask($this);
+./application/hub/main/tasks/hub/class_HubSocketListenerTask.php:69:    * @todo        0% done
 ./application/hub/main/tasks/hub/ping/class_HubPingTask.php:73:         * @todo        0% done
 ./application/hub/main/tasks/hub/update/class_HubUpdateCheckTask.php:53:        * @todo        0%
 ./application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php:10: * @todo               This template engine does not make use of setTemplateType()
 ./inc/classes/exceptions/main/class_MissingMethodException.php:13: * @todo             Try to rewrite user/guest login classes and mark this exception as deprecated
 ./inc/classes/exceptions/main/class_NoConfigEntryException.php:10: * @todo             Rename this class to NoFoundEntryException
 ./inc/classes/interfaces/class_FrameworkInterface.php:11: * @todo              Find a better name for this interface
-./inc/classes/main/class_BaseFrameworkSystem.php:1197:  * @todo        Write a logging mechanism for productive mode
-./inc/classes/main/class_BaseFrameworkSystem.php:1211:                 // @TODO Finish this part!
-./inc/classes/main/class_BaseFrameworkSystem.php:169:  // @todo Try to clean these constants up
-./inc/classes/main/class_BaseFrameworkSystem.php:368:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
+./inc/classes/main/class_BaseFrameworkSystem.php:1263:  * @todo        Write a logging mechanism for productive mode
+./inc/classes/main/class_BaseFrameworkSystem.php:1277:                 // @TODO Finish this part!
+./inc/classes/main/class_BaseFrameworkSystem.php:195:  // @todo Try to clean these constants up
+./inc/classes/main/class_BaseFrameworkSystem.php:434:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
 ./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:       * @todo        Add some stuff here: Some personal data, app/game related data
 ./inc/classes/main/commands/web/class_WebProblemCommand.php:58:         * @todo        0% done
 ./inc/classes/main/commands/web/class_WebStatusCommand.php:58:  * @todo        0% done
 ./inc/classes/main/response/image/class_ImageResponse.php:91:   * @todo        this will send only one cookie out, the first one.
 ./inc/classes/main/result/class_DatabaseResult.php:226:         * @todo        0% done
 ./inc/classes/main/result/class_DatabaseResult.php:379:4        * @todo        Find a caching way without modifying the result array
-./inc/classes/main/rng/class_RandomNumberGenerator.php:152:     * @todo        I had a better random number generator here but now it is somewhere lost :(
+./inc/classes/main/rng/class_RandomNumberGenerator.php:161:     * @todo        I had a better random number generator here but now it is somewhere lost :(
 ./inc/classes/main/rng/class_RandomNumberGenerator.php:83:      * @todo        Add site key for stronger salt!
 ./inc/classes/main/template/class_BaseTemplateEngine.php:1055:                 // @TODO This silent abort should be logged, maybe.
 ./inc/classes/main/template/class_BaseTemplateEngine.php:1063:                 // @TODO Old behaviour, will become obsolete!
 ./inc/loader/class_ClassLoader.php:264:                        /* @todo: Do not die here. */
 ./inc/output.php:11: * @todo           We should minimize these includes
 ./inc/selector.php:11: * @todo         We should minimize these includes
-./index.php:59:         * @todo        This method is old code and needs heavy rewrite
+./index.php:59:         * @todo        This method is old code and needs heavy rewrite and should be moved to ApplicationHelper
 ### ### DEPRECATION FOLLOWS: ### ###
 ./application/hub/interfaces/messages/class_MessageHelper.php:2:// @DEPRECATED
 ./application/hub/main/database/wrapper/class_NodeInformationDatabaseWrapper.php:2:// @DEPRECATED
 ./application/hub/main/database/wrapper/class_NodeListDatabaseWrapper.php:2:// @DEPRECATED
 ./application/hub/main/database/wrapper/class_PeerStateLookupDatabaseWrapper.php:2:// @DEPRECATED
+./application/hub/main/database/wrapper/states/class_PeerStateLookupDatabaseWrapper.php:2:// @DEPRECATED
+./application/hub/main/factories/states/class_StateFactory.php:2:// @DEPRECATED
 ./application/hub/main/filter/activation/class_HubActivationSelfAnnouncementFilter.php:2:// @DEPRECATED
 ./application/hub/main/filter/bootstrap/class_HubBootstrapAquireHubIdFilter.php:2:// @DEPRECATED
 ./application/hub/main/filter/bootstrap/class_HubBootstrapExtraBootstrappingFilter.php:2:// @DEPRECATED
 ./application/hub/main/filter/task/class_CruncherTaskHandlerInitializerFilter.php:2:// @DEPRECATED
 ./application/hub/main/filter/task/class_HubTaskHandlerInitializerFilter.php:2:// @DEPRECATED
 ./application/hub/main/filter/task/class_TaskHandlerInitializerFilter.php:2:// @DEPRECATED
+./application/hub/main/handler/network/class_BaseNetworkPackageHandler.php:2:// @DEPRECATED
+./application/hub/main/handler/network/tcp/class_TcpNetworkPackageHandler.php:2:// @DEPRECATED
+./application/hub/main/handler/network/udp/class_UdpNetworkPackageHandler.php:2:// @DEPRECATED
 ./application/hub/main/helper/messages/crypto/class_CryptoRandomMessageHelper.php:2:// @DEPRECATED
 ./application/hub/main/iterator/producer/class_TestUnitKeyProducerIterator.php:2:// @DEPRECATED
-./application/hub/main/nodes/class_BaseHubNode.php:58:  * @deprecated
+./application/hub/main/listener/tcp/decorators/class_PeerTcpListenerDecorator.php:2:// @DEPRECATED
+./application/hub/main/listener/udp/decorators/class_PeerUdpListenerDecorator.php:2:// @DEPRECATED
+./application/hub/main/lookup/peer/class_PeerStateLookupTable.php:2:// @DEPRECATED
+./application/hub/main/nodes/class_BaseHubNode.php:53:  * @deprecated
+./application/hub/main/states/peer/new/class_NewConnectionPeerState.php:2:// @DEPRECATED
+./application/hub/main/streams/package/input/class_PackageInputStream.php:2:// @DEPRECATED
+./application/hub/main/streams/package/output/class_PackageOutputStream.php:2:// @DEPRECATED
 ./application/hub/main/template/announcement/class_AnnouncementTemplateEngine.php:2:// @DEPRECATED
 ./application/hub/main/template/connect/class_SelfConnectTemplateEngine.php:2:// @DEPRECATED
 ./application/hub/main/template/objects/class_ObjectRegistryTemplateEngine.php:2:// @DEPRECATED
 ./inc/classes/exceptions/language/class_MissingLanguageHandlerException.php:2:// @DEPRECATED
 ./inc/classes/exceptions/main/class_ClassNotFoundException.php:2:// @DEPRECATED
 ./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:2:// @DEPRECATED
+./inc/classes/exceptions/main/class_MissingMethodException.php:14: * @deprecated       Please do no longer use this exception
 ./inc/classes/interfaces/helper/class_HelpableLogin.php:2:// @DEPRECATED
 ./inc/classes/interfaces/helper/class_HelpableTemplate.php:2:// @DEPRECATED
+./inc/classes/main/streams/input/class_BaseInputStream.php:2:// @DEPRECATED
+./inc/classes/main/streams/output/class_BaseOutputStream.php:2:// @DEPRECATED
 ./inc/classes.php:9: * @deprecated
 ./inc/database.php:10: * @deprecated
 ./inc/file_io.php:2:// @DEPRECATED