Merge pull request #17 from rubyqorn/1.0.0

Socket options adding feature

Author: rubyqorn

README.md

@@ -2,4 +2,99 @@
 # Socket
 
 ## This is a layer for client and server socket connections.
-#### [Detailed documentation](http://socket-docs.epizy.com)
+
+### PHP extension which have to be installed before to work:
+* [PHP 8.0](https://www.php.net/downloads)
+* [Yaml](https://www.php.net/manual/en/book.yaml.php)
+* [Sockets](https://www.php.net/manual/en/book.sockets.php)
+
+### Four actions you have to make:
+* Configure your configuration file.
+* Create client.php or server.php file
+* Call methods
+* Run from CLI or extends
+
+### Examples of TCP and UNIX sockets:
+
+#### 1) Create configuration file. File can be **ONLY** with yaml(yml) or json extensions
+
+##### * TCP socket configuration using YAML
+```
+settings:
+    socket_type: tcp
+    address: 127.0.0.1
+    port: 8000
+    content_length: 2048
+```
+
+##### * UNIX socket configuration using YAML
+```
+settings:
+    socket_type: unix
+    address: socket.sock
+    content_length: 2048
+```
+
+#### 2) Create client and server file handlers.
+
+##### server.php
+```
+<?php
+
+require_once 'vendor/autoload.php';
+
+use Qonsillium\QonsilliumSocket;
+use Qonsillium\ServerSocket;
+
+$server = new QonsilliumSocket('config.yaml');
+$server->runServer(function(ServerSocket $socket) {
+    echo $socket->send('Hello from server!');
+});
+```
+
+##### client.php
+```
+<?php
+
+require_once 'vendor/autoload.php';
+
+use Qonsillium\QonsilliumSocket;
+use Qonsillium\ClientSocket;
+
+$server = new QonsilliumSocket('config.yaml');
+$server->runClient(function(ClinetSocket $socket) {
+    echo $socket->send('Hello from client!');
+});
+```
+
+#### 3) Run from CLI
+```
+ john@doe:/workdir/$ php server.php
+ john@doe:/workdir/$ php client.php
+```
+
+#### 4) Extends from QonsilliumSocket
+```
+<?php 
+
+namespace App;
+
+use Qonsillium\QonsilliumSocket
+use Qonillium\ClientSocket
+
+class SocketMessagePrinter extends QonsilliumSocket
+{
+    public function handleServerSocketMessage(string $myMessage)
+    {
+        $serverMessage = $this->runClient(function(ClientSocket $client) use ($myMessage) {
+            return $client->send($myMessage);
+        });
+
+        if ($serverMessage === 'Hello from server!') {
+            // handle this action
+        }
+    }
+}
+```
+
+But when you will instantiate handler class don't forget to set configuration file with socket settings in constructor method

src/ActionFactory.php

@@ -38,6 +38,15 @@ public function getAddress()
         return $this->credentials->getCredential('host');
     }
 
+    /**
+     * Returns socket read legnth
+     * @return int 
+     */ 
+    private function getReadLength()
+    {
+        return $this->credentials->getCredential('content_length');
+    }
+
     /**
      * @return \Qonsillium\Actions\SocketConnector 
      */ 
@@ -59,7 +68,7 @@ public function getAcceptor(): SocketAcceptor
      */ 
     public function getReader(): SocketReader
     {
-        return new SocketReader();
+        return new SocketReader($this->getReadLength());
     }
 
     /**

src/Actions/Connections/ClientConnection.php

@@ -13,7 +13,8 @@ public function create()
         return stream_socket_client(
             $this->getAddress(),
             $errno,
-            $errstr
+            $errstr,
+            $this->getTimeout() ?? $this->getTimeout()
         );
     }
 }

src/Actions/Connections/Connection.php

@@ -12,9 +12,9 @@ abstract class Connection
 
     /**
      * Socket connection timeout
-     * @var int 
+     * @var int|null 
      */ 
-    protected int $timeout;
+    protected ?int $timeout = null;
 
     /**
      * @param string $address

src/Actions/SocketReader.php

@@ -9,6 +9,21 @@ class SocketReader extends AbstractSocketAction
      */ 
     private string $message;
 
+    /**
+     * @var int 
+     */ 
+    private int $length;
+
+    /**
+     * Initiate SocketReader constructor method 
+     * @param int $length 
+     * @return void 
+     */ 
+    public function __construct(int $length)
+    {   
+        $this->length = $length;
+    }
+
     /**
      * @param string $message
      * @return void 
@@ -32,7 +47,7 @@ public function getMessage()
      */ 
     public function make()
     {
-        $this->setMessage(fread($this->getSocket(), 2048));
+        $this->setMessage(fread($this->getSocket(), $this->length));
         return $this;
     }
 }

src/Bootstrapper.php

@@ -74,9 +74,23 @@ public function setCredentials()
         $socketTypeFactory = $this->getSocketTypeFactory();
         $socketType = $socketTypeFactory->getSocket($this->settings['settings']['socket_type']);
 
+        // Set socket host credentials. We have only two types
+        // It's unix and tcp, another will be ignored
+        if ($socketType->get('socket_type') === 'unix') {
+            $credentials->setCredential(
+                'host', 
+                "{$socketType->get('socket_type')}://{$socketType->get('address')}"
+            );
+        } elseif($socketType->get('socket_type') === 'tcp') {
+            $credentials->setCredential(
+                'host', 
+                "{$socketType->get('socket_type')}://{$socketType->get('address')}:{$socketType->get('port')}"
+            );
+        }
+
         $credentials->setCredential(
-            'host', 
-            "{$socketType->get('socket_type')}://{$socketType->get('address')}:{$socketType->get('port')}"
+            'content_length', 
+            $socketType->get('content_length')
         );
 
         return $credentials;

src/QonsilliumSocket.php

@@ -62,7 +62,7 @@ protected function getServerSocket(): ServerSocket
      */ 
     public function runClient(Closure $handler)
     {
-        $handler($this->getClientSocket());
+        return $handler($this->getClientSocket());
     }
 
     /**
@@ -80,6 +80,6 @@ public function runClient(Closure $handler)
      */
     public function runServer(Closure $handler)
     {
-        $handler($this->getServerSocket());
+        return $handler($this->getServerSocket());
     }
 }

src/SocketFacade.php

@@ -3,14 +3,8 @@
 namespace Qonsillium;
 
 use Qonsillium\Exceptions\ {
-    FailedAcceptSocket,
     FailedConnectSocket,
-    FailedListenSocket,
-    FailedCreateSocket,
     FailedWriteSocket,
-    FailedCloseSocket,
-    FailedBindSocket,
-    FailedReadSocket
 };
 
 class SocketFacade