SocketKeepalive Class

Definition

[Android.Runtime.Register("android/net/SocketKeepalive", ApiSince=29, DoNotGenerateAcw=true)]
public abstract class SocketKeepalive : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Lang.IAutoCloseable

[<Android.Runtime.Register("android/net/SocketKeepalive", ApiSince=29, DoNotGenerateAcw=true)>]
type SocketKeepalive = class
    inherit Object
    interface IAutoCloseable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

SocketKeepalive

Attributes

RegisterAttribute

Implements

IJavaObject IJavaPeerable IAutoCloseable IDisposable

Remarks

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.

For cellular, the device MUST support at least 1 keepalive slot.

For WiFi, the device SHOULD support keepalive offload. If it does not, it MUST reply with SocketKeepalive.Callback#onError with ERROR_UNSUPPORTED to any keepalive offload request. If it does, it MUST support at least 3 concurrent keepalive slots.

Java documentation for android.net.SocketKeepalive.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.