return lost readme, license
This commit is contained in:
parent
9732f320a4
commit
33525e09af
|
@ -0,0 +1,22 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2015 Tradle
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
|
@ -0,0 +1,68 @@
|
||||||
|
# UDP in React Native
|
||||||
|
|
||||||
|
node's [dgram](https://nodejs.org/api/dgram.html) API in React Native
|
||||||
|
|
||||||
|
## This module is used by [Tradle](https://github.com/tradle)
|
||||||
|
|
||||||
|
PR's welcome!
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
* Create a new react-native project. [Check react-native getting started](http://facebook.github.io/react-native/docs/getting-started.html#content)
|
||||||
|
|
||||||
|
* in PROJECT_DIR/node_modules/react-native, execute:
|
||||||
|
```
|
||||||
|
npm install --save react-native-udp
|
||||||
|
```
|
||||||
|
|
||||||
|
* Drag RCTUDP.xcodeproj from node_modules/react-native-udp into your XCode project. Click on the project in XCode, go to Build Phases, then Link Binary With Libraries and add libReactUDP.a
|
||||||
|
|
||||||
|
Buckle up, Dorothy
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### package.json
|
||||||
|
|
||||||
|
_only if you want to write require('dgram') in your javascript_
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"browser": {
|
||||||
|
"dgram": "react-native-udp"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### JS
|
||||||
|
|
||||||
|
_see/run index.ios.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('RCTUDP')
|
||||||
|
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 RCTUDP to pick it up:
|
||||||
|
|
||||||
|
```js
|
||||||
|
global.Buffer = global.Buffer || require('buffer').Buffer
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
[Tradle, Inc.](https://github.com/tradle/about/wiki)
|
Loading…
Reference in New Issue