@bestiebot/react-native-ssdp

    2.9.0 • Public • Published

    This is a fork of the original Works with Yeti repo for SSDP, and the company no longer seems to be in business.

    SSDP fork for React Native from node

    This is a fork of node-ssdp that uses react-native-udp instead of dgram to enable react multicast messaging and plain socket control. The API is the same as in the forked version.

     This package powers Bestie Bot applications and is used in production. It is maintained with our developers's free time, PRs and issues are more than welcome.

    Installation

    Unless React Native Version is > 0.6 use rnpm else use react-native link.

    npm install @bestie-bot/react-native-ssdp

    Make sure you set Buffer as global in react-native-udp's UdpSockets.js (noted filename ends with letter s)

    global.Buffer = global.Buffer || require('buffer').Buffer

    Things to take note

    • Be aware that the Android emulator does not support incoming UDP traffic, so the client will not get any responses to search requests. For best results, test on a real device when using Android. The iOS simulator, on the other hand, works just fine.

    • Make sure you close all the sockets you open and never try to reopen one already open, mobile OSs and React Native are very aggresive both with security and performance, so a misuse could kill your process.

    Usage (Android)

    android/settings.gradle

    ...
    include ':react-native-udp'
    project(':react-native-udp').projectDir = new File(settingsDir, '../node_modules/react-native-udp/android')
    include ':react-native-network-info'
    project(':react-native-network-info').projectDir = new File(settingsDir, '../node_modules/react-native-network-info/android')

    android/app/build.gradle

    ...
    dependencies {
    	...
    	compile project(':react-native-udp')
    	compile project(':react-native-network-info')
    }

    register module in MainActivity.java

    For RN 0.19.0 and higher

    import com.tradle.react.UdpSocketsModule;  // <--- import
    import com.pusherman.networkinfo.RNNetworkInfoPackage; // <--- import
    
    public class MainActivity extends ReactActivity {
       // ...
        @Override
        protected List<ReactPackage> getPackages() {
          return Arrays.<ReactPackage>asList(
            new MainReactPackage(), // <---- add comma
    		new UdpSocketsModule(), // <---- add package
            new RNNetworkInfoPackage() // <---------- add package
          );
        }

    For react-native 0.29.0 and higher ( in MainApplication.java )

    import com.tradle.react.UdpSocketsModule;  // <--- import
    import com.pusherman.networkinfo.RNNetworkInfoPackage; // <--- import
    
    public class MainApplication extends Application implements ReactApplication {
       // ...
        @Override
        protected List<ReactPackage> getPackages() {
          return Arrays.<ReactPackage>asList(
            new MainReactPackage(), // <---- add comma
            new UdpSocketsModule(), // <---- add package
    		new RNNetworkInfoPackage() <---- add package
          );
        }

    Usage (iOS)

    Adding with CocoaPads

    Add the RNFS pod to your list of applications pods in your podfile, using the path from the Podfile to the installed module.

    pod 'RNUDP', :path => './node_modules/react-native-udp'
    pod 'RNNetworkInfo', :path => './node_modules/react-native-network-info'
    

    Install pods as usual:

    pod install
    

    Adding manually in Xcode

    In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name] Go to node_modules ➜ react-native-fs and add the .xcodeproj file

    In XCode, in the project navigator, select your project. Add the lib*.a from the RNFS project to your project's Build Phases ➜ Link Binary With Libraries. Click the .xcodeproj file you added before in the project navigator and go the Build Settings tab. Make sure 'All' is toggled on (instead of 'Basic'). Look for Header Search Paths and make sure it contains both $(SRCROOT)/../react-native/React and $(SRCROOT)/../../React - mark both as recursive.

    Run your project (Cmd+R)

    Note: Library uses these installed native_modules internally for sockets communication.

    Usage - Client

        var Client = require('react-native-ssdp').Client
          , client = new Client();
    
        client.on('response', function (headers, statusCode, rinfo) {
          console.log('Got a response to an m-search.');
        });
    
        // search for a service type
        client.search('urn:schemas-upnp-org:service:ContentDirectory:1');
    
        // Or get a list of all services on the network
    
        client.search('ssdp:all');

    Usage - Server

        var Server = require('react-native-ssdp').Server
          , server = new Server()
        ;
    
        server.addUSN('upnp:rootdevice');
        server.addUSN('urn:schemas-upnp-org:device:MediaServer:1');
        server.addUSN('urn:schemas-upnp-org:service:ContentDirectory:1');
        server.addUSN('urn:schemas-upnp-org:service:ConnectionManager:1');
    
        server.on('advertise-alive', function (headers) {
          // Expire old devices from your cache.
          // Register advertising device somewhere (as designated in http headers heads)
        });
    
        server.on('advertise-bye', function (headers) {
          // Remove specified device from cache.
        });
    
        // start the server
        server.start();
    
        process.on('exit', function(){
          server.stop() // advertise shutting down and stop listening
        })

    Legacy docs from the forked repo

    Take a look at example directory as well to see examples or client and server.

    ##Configuration new SSDP([options, [socket]])

    SSDP constructor accepts an optional configuration object and an optional initialized socket. At the moment, the following is supported:

    • ssdpSig String SSDP signature. Default: node.js/NODE_VERSION UPnP/1.1 node-ssdp/PACKAGE_VERSION
    • ssdpIp String SSDP multicast group. Default: 239.255.255.250.
    • ssdpPort Number SSDP port. Default: 1900
    • ssdpTtl Number Multicast TTL. Default: 1
    • adInterval Number advertise event frequency (ms). Default: 10 sec.
    • unicastHost String IP address or hostname of server where SSDP service is running. This is used in HOST header. Default: 0.0.0.0.
    • location String URL pointing to description of your service, or a function which returns that URL
    • udn String Unique Device Name. Default: uuid:f40c2981-7329-40b7-8b04-27f187aecfb5.
    • description String Path to description file. Default: upnp/desc.php.
    • ttl Number Packet TTL. Default: 1800.
    • allowWildcards Boolean Accept wildcards (*) in serviceTypes of M-SEARCH packets, e.g. usn:Belkin:device:**. Default: false

    ###Logging

    You can enable logging via an environment variable DEBUG. Set DEBUG=node-ssdp* to enable all logs. To enable only client or server logs, use DEBUG=node-ssdp:client or DEBUG=node-ssdp:server respectively.

    License

    (The MIT License)

    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.

    Install

    npm i @bestiebot/react-native-ssdp

    DownloadsWeekly Downloads

    1

    Version

    2.9.0

    License

    MIT

    Unpacked Size

    43 kB

    Total Files

    15

    Last publish

    Collaborators

    • bestiebot-support