react-native-udp

React Native UDP socket API for Android & iOS. It allows you to create UDP sockets, imitating Node's dgram API functionalities (check each method documentation for more information).

_This module is used by Tradle._

Table of Contents

- Getting started
- Compatibility
- Usage
- Maintainers
- License

Getting started

Install the library using either Yarn:

``
yarn add react-native-udp
`

or npm:

`
npm install --save react-native-udp
`

#### Using React Native >= 0.60

Linking the package manually is not required anymore with Autolinking.

- iOS Platform:

$ cd ios && pod install && cd .. # CocoaPods on iOS needs this extra step

#### Using React Native < 0.60

You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:

$ react-native link react-native-udp

If you can't or don't want to use the CLI tool, you can also manually link the library using the instructions below (click on the arrow to show them):

React Native Compatibility

| React Native Version | Use Version |
| -------------------- | ----------- |
| <=0.59.10 | <=2.7.0 |
| >=0.60.0 | >=3.0.0 |

Usage

_see/run index.js for a complete example, but the interface is like dgram's_

`js
import dgram from 'react-native-udp'

const socket = dgram.createSocket('udp4')
socket.bind(12345)
socket.once('listening', function() {
socket.send('Hello World!', undefined, undefined, remotePort, remoteHost, function(err) {
if (err) throw err

console.log('Message sent!')
})
})

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

$3

To log all info emitted from the socket, add debug option when creating the socket:

`js
const socket = dgram.createSocket({
type: 'udp4',
debug: true,
})
`

Maintainers

- Rapsssito [Support me :heart:]
- Mark Vayngrib

License

The library is released under the MIT license. For more information see LICENSE`.