com.microsoft.azure.javamsalruntime

Class SignOutResultHandle

java.lang.Object

com.sun.jna.PointerType

com.sun.jna.ptr.ByReference

com.sun.jna.ptr.LongByReference

com.microsoft.azure.javamsalruntime.SignOutResultHandle

All Implemented Interfaces:

com.sun.jna.NativeMapped, AutoCloseable

public class SignOutResultHandle
extends com.sun.jna.ptr.LongByReference

Represents an MSALRUNTIME_SIGNOUT_RESULT_HANDLE

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jna.ptr.LongByReference	msalRuntimeHandle

Constructor Summary

Constructors

Constructor and Description
SignOutResultHandle()

Method Summary

Modifier and Type	Method and Description
void	close() Used to automatically release handles created in a try-with-resources block
void	release() All Java objects created by the interop will either be cleaned up by the JVM's garbage collector or by the operating system if the JVM shuts down, however the MSALRuntime handles and their underlying data won't be since the JVM doesn't actually know about that data
long	value() Returns the handle value that this Handle instance represents.

Methods inherited from class com.sun.jna.ptr.LongByReference

getValue, setValue, toString

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

msalRuntimeHandle

protected com.sun.jna.ptr.LongByReference msalRuntimeHandle

Constructor Detail

SignOutResultHandle

public SignOutResultHandle()

Method Detail

value

public long value()

Returns the handle value that this Handle instance represents. This value is generally set by MSALRuntime, and is how the interop can access data managed by MSALRuntime

release

public void release()

All Java objects created by the interop will either be cleaned up by the JVM's garbage collector or by the operating system if the JVM shuts down, however the MSALRuntime handles and their underlying data won't be since the JVM doesn't actually know about that data

So, to avoid memory leaks all MSALRuntime handles must eventually be 'released' by calling the appropriate MSALRuntime MSALRuntime_RELEASE* API for that type of handle

In most cases a handle can be released immediately after using it to retrieve some data, however there are some scenarios where handles must be stored for an indefinite amount of time and we must rely on Java's PhantomReference and our AsyncHandleFinalizerThread

close

public void close()

Used to automatically release handles created in a try-with-resources block

Specified by:

close in interface AutoCloseable