IpSecManager.SecurityParameterIndex

Kotlin |Java

public static final class IpSecManager.SecurityParameterIndex
extends Object implements AutoCloseable

java.lang.Object
↳	android.net.IpSecManager.SecurityParameterIndex

This class represents a reserved SPI.

Objects of this type are used to track reserved security parameter indices. They can be obtained by calling IpSecManager.allocateSecurityParameterIndex and must be released by calling close() when they are no longer needed.

Summary

Public methods
`void`	`close()` Release an SPI that was previously reserved.
`int`	`getSpi()` Get the underlying SPI held by this object.
`String`	`toString()` Returns a string representation of the object.

Protected methods
`void`	`finalize()` Check that the SPI was closed properly.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

close

Added in API level 28

public void close ()

Release an SPI that was previously reserved.

Release an SPI for use by other users in the system. If a SecurityParameterIndex is applied to an IpSecTransform, it will become unusable for future transforms but should still be closed to ensure system resources are released.

getSpi

Added in API level 28

public int getSpi ()

Get the underlying SPI held by this object.

Returns
`int`

toString

Added in API level 28

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

Protected methods

finalize

Added in API level 28

protected void finalize ()

Check that the SPI was closed properly.

Throws
`Throwable`