react-native-ping-android v1.3.0

react-native-ping-android

Expose the Internet Control Message Protocol (ICMP) to React Native android app.
Measure the round-trip time (RTT) by using ICMP echo request packets to the intended destination.

Installation

npm install react-native-ping-android

or with Yarn

yarn add react-native-ping-android

🚀 This library is supported in New Architecture (Turbo Modules)

APIs

ICMP

A bare JavaScript class to use ICMP controller

import { useRef } from 'react'
import { Button } from 'react-native'

import {
    ICMP,
    type ICMPResultInterface,
} from 'react-native-ping-android'

export default function App(): React.JSX.Element {
    const
        ref =
            useRef({
                icmp: new ICMP({ host: '1.1.1.1', packetSize: 64, timeout: 2000 }),
            }),

        [result, setResult] =
            useState<ICMPResultInterface | null>(null)

    const onPress = async () => {
        const { rtt, ttl, status } = await ref.current.icmp.ping()
        setResult({ rtt, ttl, status })
    }

    return (
        <Button
            title="Ping"
            onPress={ onPress } 
        />
    )
}

References

- Constructors: (data: ICMPConstructorDataInterface)

- Methods

- Properties

- Static Members

This API doesn't provide the count and interval functional arguments like in Windows/Darwin/Linux terminal.
If you want those, you can use the useICMP() React hook or you can implement your own interval and counter with this class. Feel free to create your own convinience.

It's safe to unmount the component without invoke the cancel method, like back to previous stack navigation, or unmount component with conditional rendering.

Good to hear that this module is using Kotlin Coroutines.

useICMP

A React hook of encapsulated ICMP class that you can use to simplify the ping handle with the count and the interval functional, since the ICMP class doesn't provide those arguments.

import { Button } from 'react-native'

import {
    useICMP,
} from 'react-native-ping-android'

export default function App(): React.JSX.Element {
    const { isRunning, result, start, stop } = useICMP()

    useEffect(() => {
        if(result) {
            console.log('Result: ', result.rtt, result.ttl, result.status)
        }
    }, [result])

    const toggle = () => {
        if(isRunning) {
            stop()
        } else {
            start({
                host: 'guthib.com',
                packetSize: 64,
                timeout: 1000,
                count: 10,
                interval: 1000,
            })
        }
    }

    return (
        <Button
            title={ isRunning ? 'Stop' : 'Start' }
            onPress={ toggle }
        />
    )
}

You can see full example at /example/src/screens/ping-runner/index.tsx

It's safe to unmount without invoke the stop method. This hook will cleanup the interval handler automatically.

Requirements
- Count must be larger than 0.
- Interval must be >= Timeout.

Otherwise, result will return with PingStatus.INVALID_ARG

References

- Returns: UseICMPInterface

isReachable

(host: string, timeout?: number) => Promise<boolean | null>

Simple function to test whether that address is reachable. Android implementation attempts ICMP ECHO REQUESTs first, on failure it will fall back to TCP ECHO REQUESTs. Success on either protocol will return true.

The host argument can either be a machine name, such as "guthib.com", or a textual representation of its IP address.
The timeout is 10000 (10 seconds) by default.

import { Button } from 'react-native'

import {
    isReachable,
} from 'react-native-ping-android'

export default function App(): React.JSX.Element {
    const onPress = async () => {
        const isReached = await isReachable('guthib.com')
        console.log('Is reached: ', isReached)
    }

    return (
        <Button
            title="Test"
            onPress={ onPress }
        />
    )
}

getHostName

(host: string) => Promise<string | null>

If the host argument was given with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service.

Definitions

ICMPResultInterface

ICMPConstructorDataInterface

UseICMPInterface

UseICMPStartParamsInterface

It extends ICMPConstructorDataInterface | Properties | Type | Remarks | | ------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | count | number | Count must be larger than 0. Otherwise, the result will be returned with PingStatus.INVALID_ARG status | interval | number | Value in milliseconds and must be larger than 0 and larger than the timeout. Otherwise, the result will be returned with PingStatus.INVALID_ARG status | … | … | other props from ICMPConstructorDataInterface

PingStatus

Android Emulator Limitations

Depending on the environment, the emulator might not be able to support other protocols (such as ICMP, used for "ping"). See Local networking limitations.

Instead, you can use Android physical device and run React Native app in it.