SocketRelay::sendPackage() - Code Metrics - Inspection of "Merge #51" - spiral/goridge - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd49b2...323004 )

unknown

created 2020-04-21 12:41 UTC

SocketRelay::sendPackage() A

↳ Parent: SocketRelay

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	4
dl	0
loc	23
rs	9.552
c	0
b	0
f	0

<?php
/**
 * Dead simple, high performance, drop-in bridge to Golang RPC with zero dependencies
 *
 * @author Wolfy-J
 */

namespace Spiral\Goridge;

use Spiral\Goridge\Exceptions\GoridgeException;
use Spiral\Goridge\Exceptions\PrefixException;
use Spiral\Goridge\Exceptions\RelayException;
use Spiral\Goridge\Exceptions\TransportException;

/**
 * Communicates with remote server/client over be-directional socket using byte payload:
 *
 * [ prefix       ][ payload                               ]
 * [ 1+8+8 bytes  ][ message length|LE ][message length|BE ]
 *
 * prefix:
 * [ flag       ][ message length, unsigned int 64bits, LittleEndian ]
 */
class SocketRelay implements RelayInterface
{
    /** Supported socket types. */
    const SOCK_TCP  = 0;
    const SOCK_UNIX = 1;

    // @deprecated
    const SOCK_TPC = self::SOCK_TCP;

    /** @var string */
    private $address;

    /** @var int|null */
    private $port;

    /** @var int */
    private $type;

    /** @var resource|null */
    private $socket;

    /**
     * Example:
     * $relay = new SocketRelay("localhost", 7000);
     * $relay = new SocketRelay("/tmp/rpc.sock", null, Socket::UNIX_SOCKET);
     *
     * @param string   $address Localhost, ip address or hostname.
     * @param int|null $port    Ignored for UNIX sockets.
     * @param int      $type    Default: TCP_SOCKET
     *
     * @throws Exceptions\InvalidArgumentException
     */
    public function __construct(string $address, int $port = null, int $type = self::SOCK_TCP)
    {
        if (!extension_loaded('sockets')) {
            throw new Exceptions\InvalidArgumentException("'sockets' extension not loaded");
        }

        switch ($type) {
            case self::SOCK_TCP:
                if ($port === null) {
                    throw new Exceptions\InvalidArgumentException(sprintf(
                        "no port given for TPC socket on '%s'",
                        $address
                    ));
                }
                break;
            case self::SOCK_UNIX:
                $port = null;
                break;
            default:
                throw new Exceptions\InvalidArgumentException(sprintf(
                    "undefined connection type %s on '%s'",
                    $type,
                    $address
                ));
        }

        $this->address = $address;
        $this->port = $port;
        $this->type = $type;
    }

    /**
     * {@inheritdoc}
     */
    public function sendPackage(
        string $headerPayload,
        ?int $headerFlags,
        string $bodyPayload,
        ?int $bodyFlags = null
    ) {
        $this->connect();

        $headerPackage = packMessage($headerPayload, $headerFlags);
        $bodyPackage = packMessage($bodyPayload, $bodyFlags);
        if ($headerPackage === null || $bodyPackage === null) {
            throw new TransportException('unable to send payload with PAYLOAD_NONE flag');
        }

        socket_send(
            $this->socket,
            $headerPackage['body'] . $bodyPackage['body'],
            34 + $headerPackage['size'] + $bodyPackage['size'],
            0
        );

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function send($payload, int $flags = null)
    {
        $this->connect();

        $package = packMessage($payload, $flags);
        if ($package === null) {
            throw new TransportException('unable to send payload with PAYLOAD_NONE flag');
        }

        socket_send($this->socket, $package['body'], 17 + $package['size'], 0);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function receiveSync(int &$flags = null)
    {
        $this->connect();

        $prefix = $this->fetchPrefix();
        $flags = $prefix['flags'];
        $result = null;

        if ($prefix['size'] !== 0) {
            $readBytes = $prefix['size'];
            $buffer = null;

            //Add ability to write to stream in a future
            while ($readBytes > 0) {
                $bufferLength = socket_recv(
                    $this->socket,
                    $buffer,
                    min(self::BUFFER_SIZE, $readBytes),
                    MSG_WAITALL
                );

                $result .= $buffer;
                $readBytes -= $bufferLength;
            }
        }

        return $result;
    }

    /**
     * @return string
     */
    public function getAddress(): string
    {
        return $this->address;
    }

    /**
     * @return int|null
     */
    public function getPort()
    {
        return $this->port;
    }

    /**
     * @return int
     */
    public function getType(): int
    {
        return $this->type;
    }

    /**
     * @return bool
     */
    public function isConnected(): bool
    {
        return $this->socket != null;
    }

    /**
     * Ensure socket connection. Returns true if socket successfully connected
     * or have already been connected.
     *
     * @return bool
     *
     * @throws RelayException
     * @throws \Error When sockets are used in unsupported environment.
     */
    public function connect(): bool
    {
        if ($this->isConnected()) {
            return true;
        }

        $this->socket = $this->createSocket();
        try {
            if (socket_connect($this->socket, $this->address, $this->port) === false) {
                throw new RelayException(socket_strerror(socket_last_error($this->socket)));
            }
        } catch (\Exception $e) {
            throw new RelayException("unable to establish connection {$this}", 0, $e);
        }

        return true;
    }

    /**
     * Close connection.
     *
     * @throws RelayException
     */
    public function close()
    {
        if (!$this->isConnected()) {
            throw new RelayException("unable to close socket '{$this}', socket already closed");
        }

        socket_close($this->socket);
        $this->socket = null;
    }

    /**
     * Destruct connection and disconnect.
     */
    public function __destruct()
    {
        if ($this->isConnected()) {
            $this->close();
        }
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        if ($this->type == self::SOCK_TCP) {
            return "tcp://{$this->address}:{$this->port}";
        }

        return "unix://{$this->address}";
    }

    /**
     * @return array Prefix [flag, length]
     *
     * @throws PrefixException
     */
    private function fetchPrefix(): array
    {
        $prefixLength = socket_recv($this->socket, $prefixBody, 17, MSG_WAITALL);
        if ($prefixBody === false || $prefixLength !== 17) {
            throw new PrefixException(sprintf(
                "unable to read prefix from socket: %s",
                socket_strerror(socket_last_error($this->socket))
            ));
        }

        $result = unpack("Cflags/Psize/Jrevs", $prefixBody);
        if (!is_array($result)) {
            throw new Exceptions\PrefixException("invalid prefix");
        }

        if ($result['size'] != $result['revs']) {
            throw new Exceptions\PrefixException("invalid prefix (checksum)");
        }

        return $result;
    }

    /**
     * @return resource
     * @throws GoridgeException
     */
    private function createSocket()
    {
        if ($this->type === self::SOCK_UNIX) {
            return socket_create(AF_UNIX, SOCK_STREAM, 0);
        }

        return socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
    }
}


1			<?php
2			/**
3			* Dead simple, high performance, drop-in bridge to Golang RPC with zero dependencies
4			*
5			* @author Wolfy-J
6			*/
7
8			namespace Spiral\Goridge;
9
10			use Spiral\Goridge\Exceptions\GoridgeException;
11			use Spiral\Goridge\Exceptions\PrefixException;
12			use Spiral\Goridge\Exceptions\RelayException;
13			use Spiral\Goridge\Exceptions\TransportException;
14
15			/**
16			* Communicates with remote server/client over be-directional socket using byte payload:
17			*
18			* [ prefix ][ payload ]
19			* [ 1+8+8 bytes ][ message length\|LE ][message length\|BE ]
20			*
21			* prefix:
22			* [ flag ][ message length, unsigned int 64bits, LittleEndian ]
23			*/
24			class SocketRelay implements RelayInterface
25			{
26			/** Supported socket types. */
27			const SOCK_TCP = 0;
28			const SOCK_UNIX = 1;
29
30			// @deprecated
31			const SOCK_TPC = self::SOCK_TCP;
32
33			/** @var string */
34			private $address;
35
36			/** @var int\|null */
37			private $port;
38
39			/** @var int */
40			private $type;
41
42			/** @var resource\|null */
43			private $socket;
44
45			/**
46			* Example:
47			* $relay = new SocketRelay("localhost", 7000);
48			* $relay = new SocketRelay("/tmp/rpc.sock", null, Socket::UNIX_SOCKET);
49			*
50			* @param string $address Localhost, ip address or hostname.
51			* @param int\|null $port Ignored for UNIX sockets.
52			* @param int $type Default: TCP_SOCKET
53			*
54			* @throws Exceptions\InvalidArgumentException
55			*/
56			public function __construct(string $address, int $port = null, int $type = self::SOCK_TCP)
57			{
58			if (!extension_loaded('sockets')) {
59			throw new Exceptions\InvalidArgumentException("'sockets' extension not loaded");
60			}
61
62			switch ($type) {
63			case self::SOCK_TCP:
64			if ($port === null) {
65			throw new Exceptions\InvalidArgumentException(sprintf(
66			"no port given for TPC socket on '%s'",
67			$address
68			));
69			}
70			break;
71			case self::SOCK_UNIX:
72			$port = null;
73			break;
74			default:
75			throw new Exceptions\InvalidArgumentException(sprintf(
76			"undefined connection type %s on '%s'",
77			$type,
78			$address
79			));
80			}
81
82			$this->address = $address;
83			$this->port = $port;
84			$this->type = $type;
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90			public function sendPackage(
91			string $headerPayload,
92			?int $headerFlags,
93			string $bodyPayload,
94			?int $bodyFlags = null
95			) {
96			$this->connect();
97
98			$headerPackage = packMessage($headerPayload, $headerFlags);
99			$bodyPackage = packMessage($bodyPayload, $bodyFlags);
100			if ($headerPackage === null \|\| $bodyPackage === null) {
101			throw new TransportException('unable to send payload with PAYLOAD_NONE flag');
102			}
103
104			socket_send(
105			$this->socket,
106			$headerPackage['body'] . $bodyPackage['body'],
107			34 + $headerPackage['size'] + $bodyPackage['size'],
108			0
109			);
110
111			return $this;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function send($payload, int $flags = null)
118			{
119			$this->connect();
120
121			$package = packMessage($payload, $flags);
122			if ($package === null) {
123			throw new TransportException('unable to send payload with PAYLOAD_NONE flag');
124			}
125
126			socket_send($this->socket, $package['body'], 17 + $package['size'], 0);
127
128			return $this;
129			}
130
131			/**
132			* {@inheritdoc}
133			*/
134			public function receiveSync(int &$flags = null)
135			{
136			$this->connect();
137
138			$prefix = $this->fetchPrefix();
139			$flags = $prefix['flags'];
140			$result = null;
141
142			if ($prefix['size'] !== 0) {
143			$readBytes = $prefix['size'];
144			$buffer = null;
145
146			//Add ability to write to stream in a future
147			while ($readBytes > 0) {
148			$bufferLength = socket_recv(
149			$this->socket,
150			$buffer,
151			min(self::BUFFER_SIZE, $readBytes),
152			MSG_WAITALL
153			);
154
155			$result .= $buffer;
156			$readBytes -= $bufferLength;
157			}
158			}
159
160			return $result;
161			}
162
163			/**
164			* @return string
165			*/
166			public function getAddress(): string
167			{
168			return $this->address;
169			}
170
171			/**
172			* @return int\|null
173			*/
174			public function getPort()
175			{
176			return $this->port;
177			}
178
179			/**
180			* @return int
181			*/
182			public function getType(): int
183			{
184			return $this->type;
185			}
186
187			/**
188			* @return bool
189			*/
190			public function isConnected(): bool
191			{
192			return $this->socket != null;
193			}
194
195			/**
196			* Ensure socket connection. Returns true if socket successfully connected
197			* or have already been connected.
198			*
199			* @return bool
200			*
201			* @throws RelayException
202			* @throws \Error When sockets are used in unsupported environment.
203			*/
204			public function connect(): bool
205			{
206			if ($this->isConnected()) {
207			return true;
208			}
209
210			$this->socket = $this->createSocket();
211			try {
212			if (socket_connect($this->socket, $this->address, $this->port) === false) {
213			throw new RelayException(socket_strerror(socket_last_error($this->socket)));
214			}
215			} catch (\Exception $e) {
216			throw new RelayException("unable to establish connection {$this}", 0, $e);
217			}
218
219			return true;
220			}
221
222			/**
223			* Close connection.
224			*
225			* @throws RelayException
226			*/
227			public function close()
228			{
229			if (!$this->isConnected()) {
230			throw new RelayException("unable to close socket '{$this}', socket already closed");
231			}
232
233			socket_close($this->socket);
234			$this->socket = null;
235			}
236
237			/**
238			* Destruct connection and disconnect.
239			*/
240			public function __destruct()
241			{
242			if ($this->isConnected()) {
243			$this->close();
244			}
245			}
246
247			/**
248			* @return string
249			*/
250			public function __toString(): string
251			{
252			if ($this->type == self::SOCK_TCP) {
253			return "tcp://{$this->address}:{$this->port}";
254			}
255
256			return "unix://{$this->address}";
257			}
258
259			/**
260			* @return array Prefix [flag, length]
261			*
262			* @throws PrefixException
263			*/
264			private function fetchPrefix(): array
265			{
266			$prefixLength = socket_recv($this->socket, $prefixBody, 17, MSG_WAITALL);
267			if ($prefixBody === false \|\| $prefixLength !== 17) {
268			throw new PrefixException(sprintf(
269			"unable to read prefix from socket: %s",
270			socket_strerror(socket_last_error($this->socket))
271			));
272			}
273
274			$result = unpack("Cflags/Psize/Jrevs", $prefixBody);
275			if (!is_array($result)) {
276			throw new Exceptions\PrefixException("invalid prefix");
277			}
278
279			if ($result['size'] != $result['revs']) {
280			throw new Exceptions\PrefixException("invalid prefix (checksum)");
281			}
282
283			return $result;
284			}
285
286			/**
287			* @return resource
288			* @throws GoridgeException
289			*/
290			private function createSocket()
291			{
292			if ($this->type === self::SOCK_UNIX) {
293			return socket_create(AF_UNIX, SOCK_STREAM, 0);
294			}
295
296			return socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
297			}
298			}
299

spiral / goridge

Push — master ( bd49b2...323004 )

SocketRelay::sendPackage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like