node's dgram for react-native
Go to file
Andy Prock fbc123849f 1.2.4 2016-01-15 15:52:13 -08:00
android Fixes #14 2015-12-21 17:19:59 -08:00
examples/rctsockets point android example at the right js file 2015-11-30 14:23:27 -08:00
ios fix typo in error message 2015-12-31 08:39:33 -08:00
.gitignore ios start using lightweight generics 2015-12-16 11:47:43 -08:00
LICENSE return lost readme, license 2015-05-10 10:50:44 -04:00
README.md fix example in readme 2015-11-22 13:01:00 +00:00
UdpSocket.js remove received noisy message received log 2016-01-13 14:43:56 -08:00
UdpSockets.js initial android support 2015-09-25 14:58:32 -07:00
package.json 1.2.4 2016-01-15 15:52:13 -08:00

README.md

UDP in React Native

node's dgram API in React Native

This module is used by Tradle

Install

npm install --save react-native-udp

iOS

  • Drag UdpSockets.xcodeproj from node_modules/react-native-udp/ios into your XCode project.

  • Click on the project in XCode, go to Build Phases, then Link Binary With Libraries and add libUdpSockets.a

Android

  • android/settings.gradle
...
include ':react-native-udp'
project(':react-native-udp').projectDir = new File(settingsDir, '../node_modules/react-native-udp/android')
  • android/app/build.gradle
dependencies {
	...
	compile project(':react-native-udp')
}
  • register module (in MainActivity.java)
...

import com.tradle.react.*; // <--- import

public class MainActivity extends Activity implements DefaultHardwareBackBtnHandler {
	...

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mReactRootView = new ReactRootView(this);

        mReactInstanceManager = ReactInstanceManager.builder()
                .setApplication(getApplication())
                .setBundleAssetName("index.android.bundle")
                .setJSMainModuleName("index.android")
                .addPackage(new MainReactPackage())
                .addPackage(new UdpSocketsModule())           // <- add here
                .setUseDeveloperSupport(BuildConfig.DEBUG)
                .setInitialLifecycleState(LifecycleState.RESUMED)
                .build();

        mReactRootView.startReactApplication(mReactInstanceManager, "YourProject", null);

        setContentView(mReactRootView);
    }
}

Buckle up, Dorothy

Usage

package.json

only if you want to write require('dgram') in your javascript

{
  "browser": {
    "dgram": "react-native-udp"
  }
}

JS

see/run index.js for a complete example, but basically it's just like dgram

var dgram = require('dgram')
// OR, if not shimming via package.json "browser" field:
// var dgram = require('react-native-udp')
var socket = dgram.createSocket('udp4')
socket.bind(12345)
socket.once('listening', function() {
  var buf = toByteArray('excellent!')
  socket.send(buf, 0, buf.length, remotePort, remoteHost, function(err) {
    if (err) throw err

    console.log('message was sent')
  })
})

socket.on('message', function(msg, rinfo) {
  console.log('message was received', msg)
})

Note

If you want to send and receive node Buffer objects, you'll have to "npm install buffer" and set it as a global for UdpSockets to pick it up:

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

TODO

add select tests from node's tests for dgram

Contributors

Mark Vayngrib
Ellen Katsnelson
Tradle, Inc.

Andy Prock

PR's welcome!