Initial commit

Author: clue

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian Lück
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+# clue/ssdp-react [![Build Status](https://travis-ci.org/clue/php-ssdp-react.svg?branch=master)](https://travis-ci.org/clue/php-ssdp-react)
+
+Async [Simple Service Discovery Protocol (SSDP)](http://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), built on top of [React PHP](http://reactphp.org/).
+
+As used in [Univeral Plug and Play](http://de.wikipedia.org/wiki/Universal_Plug_and_Play) (UPnP).
+Commonly used by multimedia devices in home networks etc.
+
+See [UPnP device architecture definition](http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf) (PDF).
+Uses Multicast and Unicast UDP HTTP messages (HTTPMU/HTTPU),
+expired IETF draft: https://tools.ietf.org/html/draft-goland-http-udp-01
+
+This is an alternative to DNS-Based Service Discovery (DNS-SD)
+as defined in [RFC 6763](http://tools.ietf.org/html/rfc6763).
+
+> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
+
+## Quickstart example
+
+Once [installed](#install), you can use the following code to search all available UPnP devices in your network:
+
+```php
+$loop = React\EventLoop\Factory::create();
+$client = new Client($loop);
+
+$client->search()->then(
+    function () {
+        echo 'Search completed' . PHP_EOL;
+    },
+    function($e) {
+        echo 'There was an error searching for devices: ' . $e . PHP_EOL;
+    },
+    function ($progress) {
+        echo 'Found a device: ' . PHP_EOL;
+        var_dump($progress);
+        echo PHP_EOL;
+    }
+);
+
+$loop->run();
+```
+
+See also the [examples](examples).
+
+## Install
+
+The recommended way to install this library is [through composer](http://getcomposer.org). [New to composer?](http://getcomposer.org/doc/00-intro.md)
+
+```JSON
+{
+    "require": {
+        "clue/ssdp-react": "dev-master"
+    }
+}
+```
+
+## License
+
+MIT

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "clue/ssdp-react",
+    "description": "Async Simple Service Discovery Protocol (SSDP), part of Univeral Plug and Play (UPnP)",
+    "keywords": ["Simple Service Discovery Protocol", "SSDP", "Univeral Plug and Play", "UPnP", "ReactPHP", "async"],
+    "homepage": "https://github.com/clue/php-ssdp-react",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Lück",
+            "email": "christian@lueck.tv"
+        }
+    ],
+    "autoload": {
+        "psr-4": { "Clue\\React\\Ssdp\\": "src/" }
+    },
+    "require": {
+        "php": ">=5.3",
+        "react/event-loop": "~0.4.0|~0.3.0",
+        "react/promise": "~2.0|~1.0",
+        "clue/multicast-react": "~0.2.0"
+    }
+}

examples/demo.php

@@ -0,0 +1,24 @@
+<?php
+
+use Clue\React\Ssdp\Client;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$loop = React\EventLoop\Factory::create();
+$client = new Client($loop);
+
+$client->search()->then(
+    function () {
+        echo 'Search completed' . PHP_EOL;
+    },
+    function($e) {
+        echo 'There was an error searching for devices: ' . $e . PHP_EOL;
+    },
+    function ($progress) {
+        echo 'Found a device: ' . PHP_EOL;
+        var_dump($progress);
+        echo PHP_EOL;
+    }
+);
+
+$loop->run();

src/Client.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Clue\React\Ssdp;
+
+use React\EventLoop\LoopInterface;
+use Clue\React\Multicast\Factory as MulticastFactory;
+use React\Promise\Deferred;
+
+class Client
+{
+    const ADDRESS = '239.255.255.250:1900';
+
+    private $loop;
+    private $multicast;
+
+    public function __construct(LoopInterface $loop, MulticastFactory $multicast = null)
+    {
+        if ($multicast === null) {
+            $multicast = new MulticastFactory($loop);
+        }
+        $this->loop = $loop;
+        $this->multicast = $multicast;
+    }
+
+    public function search($searchTarget = 'ssdp:all', $mx = 2)
+    {
+        $data  = "M-SEARCH * HTTP/1.1\r\n";
+        $data .= "HOST: " . self::ADDRESS . "\r\n";
+        $data .= "MAN: \"ssdp:discover\"\r\n";
+        $data .= "MX: $mx\r\n";
+        $data .= "ST: $searchTarget\r\n";
+        $data .= "\r\n";
+
+        $socket = $this->multicast->createSender();
+        // TODO: The TTL for the IP packet SHOULD default to 2 and SHOULD be configurable.
+
+        $timer = $this->loop->addTimer($mx, function() use ($socket, &$deferred) {
+            $deferred->resolve();
+            $socket->close();
+        });
+
+        $deferred = new Deferred(function () use ($socket, &$timer) {
+            // canceling resulting promise cancels timer and closes socket
+            $timer->cancel();
+            $socket->close();
+            throw new RuntimeException('Cancelled');
+        });
+
+        $that = $this;
+        $socket->on('message', function ($data, $remote) use ($deferred, $that) {
+            $message = $that->parseMessage($data, $remote);
+
+            $deferred->progress($message);
+        });
+
+        $socket->send($data, self::ADDRESS);
+
+        return $deferred->promise();
+    }
+
+    /** @internal */
+    public function parseMessage($message, $remote)
+    {
+        // TODO: parse message into message model
+        $message = array(
+            'data' => $message,
+            '_sender' => $remote
+        );
+        return $message;
+    }
+}