Summary: Nested Classes | Constants | Methods | Inherited Methods

SocketKeepalive

public abstract class SocketKeepalive
extends Object implements AutoCloseable

java.lang.Object
↳	android.net.SocketKeepalive

Allows applications to request that the system periodically send specific packets on their behalf, using hardware offload to save battery power. To request that the system send keepalives, call one of the methods that return a SocketKeepalive object, such as ConnectivityManager#createSocketKeepalive, passing in a non-null callback. If the SocketKeepalive is successfully started, the callback's onStarted method will be called. If an error occurs, onError will be called, specifying one of the ERROR_* constants in this class. To stop an existing keepalive, call SocketKeepalive#stop. The system will call SocketKeepalive.Callback#onStopped if the operation was successful or SocketKeepalive.Callback#onError if an error occurred.

Summary

Nested classes
`class`	`SocketKeepalive.Callback` The callback which app can use to learn the status changes of `SocketKeepalive`.

Constants
`int`	`ERROR_HARDWARE_ERROR` The hardware returned an error.
`int`	`ERROR_HARDWARE_UNSUPPORTED` The hardware does not support this request.
`int`	`ERROR_INVALID_INTERVAL` The packet transmission interval is invalid (e.g., too short).
`int`	`ERROR_INVALID_IP_ADDRESS` The specified IP addresses are invalid.
`int`	`ERROR_INVALID_LENGTH` The packet length is invalid (e.g., too long).
`int`	`ERROR_INVALID_NETWORK` The specified `Network` is not connected.
`int`	`ERROR_INVALID_PORT` The requested port is invalid.
`int`	`ERROR_INVALID_SOCKET` The target socket is invalid.
`int`	`ERROR_SOCKET_NOT_IDLE` The target socket is not idle.

Public methods
`final void`	`close()` Deactivate this `SocketKeepalive` and free allocated resources.
`final void`	`start(int intervalSec)` Request that keepalive be started with the given `intervalSec`.
`final void`	`stop()` Requests that keepalive be stopped.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Constants

ERROR_HARDWARE_ERROR

Added in Android Q

public static final int ERROR_HARDWARE_ERROR

The hardware returned an error.

Constant Value: -31 (0xffffffe1)

ERROR_HARDWARE_UNSUPPORTED

Added in Android Q

public static final int ERROR_HARDWARE_UNSUPPORTED

The hardware does not support this request.

Constant Value: -30 (0xffffffe2)

ERROR_INVALID_INTERVAL

Added in Android Q

public static final int ERROR_INVALID_INTERVAL

The packet transmission interval is invalid (e.g., too short).

Constant Value: -24 (0xffffffe8)

ERROR_INVALID_IP_ADDRESS

public static final int ERROR_INVALID_IP_ADDRESS

The specified IP addresses are invalid. For example, the specified source IP address is not configured on the specified Network. * @apiSince Q

Constant Value: -21 (0xffffffeb)

ERROR_INVALID_LENGTH

Added in Android Q

public static final int ERROR_INVALID_LENGTH

The packet length is invalid (e.g., too long).

Constant Value: -23 (0xffffffe9)

ERROR_INVALID_NETWORK

Added in Android Q

public static final int ERROR_INVALID_NETWORK

The specified Network is not connected.

Constant Value: -20 (0xffffffec)

ERROR_INVALID_PORT

Added in Android Q

public static final int ERROR_INVALID_PORT

The requested port is invalid.

Constant Value: -22 (0xffffffea)

ERROR_INVALID_SOCKET

Added in Android Q

public static final int ERROR_INVALID_SOCKET

The target socket is invalid.

Constant Value: -25 (0xffffffe7)

ERROR_SOCKET_NOT_IDLE

Added in Android Q

public static final int ERROR_SOCKET_NOT_IDLE

The target socket is not idle.

Constant Value: -26 (0xffffffe6)

Public methods

close

Added in Android Q

public final void close ()

Deactivate this SocketKeepalive and free allocated resources. The instance won't be usable again if close() is called.

start

Added in Android Q

public final void start (int intervalSec)

Request that keepalive be started with the given intervalSec. See SocketKeepalive.

Parameters
`intervalSec`	`int`: The target interval in seconds between keepalive packet transmissions. The interval should be between 10 seconds and 3600 seconds, otherwise `ERROR_INVALID_INTERVAL` will be returned. Value is between MIN_INTERVAL_SEC and MAX_INTERVAL_SEC inclusive

stop

Added in Android Q

public final void stop ()

Requests that keepalive be stopped. The application must wait for Callback#onStopped before using the object. See SocketKeepalive.

SocketKeepalive

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

ERROR_HARDWARE_ERROR

ERROR_HARDWARE_UNSUPPORTED

ERROR_INVALID_INTERVAL

ERROR_INVALID_IP_ADDRESS

ERROR_INVALID_LENGTH

ERROR_INVALID_NETWORK

ERROR_INVALID_PORT

ERROR_INVALID_SOCKET

ERROR_SOCKET_NOT_IDLE

Public methods

close

start

stop