]> git.mxchange.org Git - core.git/blob - framework/main/classes/streams/crypto/class_BaseCryptoStream.php
Continued:
[core.git] / framework / main / classes / streams / crypto / class_BaseCryptoStream.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Stream\Crypto;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
7 use Org\Mxchange\CoreFramework\Stream\BaseStream;
8
9 /**
10  * A general crypto stream class
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
30  */
31 abstract class BaseCryptoStream extends BaseStream {
32         /**
33          * Instance of a RNG
34          */
35         private $rngInstance = NULL;
36
37         /**
38          * Protected constructor
39          *
40          * @param       $className      Name of the class
41          * @return      void
42          */
43         protected function __construct (string $className) {
44                 // Call parent constructor
45                 parent::__construct($className);
46         }
47
48         /**
49          * Setter for RNG instance
50          *
51          * @param       $rngInstance    An instance of a random number generator (RNG)
52          * @return      void
53          */
54         protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
55                 $this->rngInstance = $rngInstance;
56         }
57
58         /**
59          * Getter for RNG instance
60          *
61          * @return      $rngInstance    An instance of a random number generator (RNG)
62          */
63         protected final function getRngInstance () {
64                 return $this->rngInstance;
65         }
66
67 }