host.anzo.eossdk.eos.sdk.playerdatastorage

Class EOS_PlayerDataStorageFileTransferRequest

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.playerdatastorage.EOS_PlayerDataStorageFileTransferRequest

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.lang.AutoCloseable

public class EOS_PlayerDataStorageFileTransferRequest
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable

Handle type to a File Request

Since:

8/22/2023

Constructor Summary

Constructors

Constructor and Description
EOS_PlayerDataStorageFileTransferRequest()
EOS_PlayerDataStorageFileTransferRequest(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_EResult	cancelRequest() Attempt to cancel this file request in progress.
void	close()
java.lang.String	getFilename() Get the file name of the file this request is for.
EOS_EResult	getFileRequestState() Get the current state of a file request.
void	release() Free the memory used by a cloud-storage file request handle.

Methods inherited from class com.sun.jna.PointerType

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EOS_PlayerDataStorageFileTransferRequest

public EOS_PlayerDataStorageFileTransferRequest(com.sun.jna.Pointer address)

EOS_PlayerDataStorageFileTransferRequest

public EOS_PlayerDataStorageFileTransferRequest()

Method Detail

getFileRequestState

public EOS_EResult getFileRequestState()

Get the current state of a file request.

Returns:

EOS_Success if complete and successful, EOS_PlayerDataStorage_RequestInProgress if the request is still in progress, or another state for failure.

getFilename

public java.lang.String getFilename()
                             throws EOSException

Get the file name of the file this request is for. OutStringLength will always be set to the string length of the file name if it is not NULL.

Returns:

NULL-terminated utf8 file name

Throws:

EOSException - if exception occurred

See Also:

EOS_PlayerDataStorage_Interface.EOS_PLAYERDATASTORAGE_FILENAME_MAX_LENGTH_BYTES

cancelRequest

public EOS_EResult cancelRequest()

Attempt to cancel this file request in progress. This is a best-effort command and is not guaranteed to be successful if the request has completed before this function is called.

Returns:

EOS_Success if cancel is successful, EOS_NoChange if request had already completed (can't be canceled), EOS_AlreadyPending if it's already been canceled before (this is a final state for canceled request and won't change over time).

release

public void release()

Free the memory used by a cloud-storage file request handle. This will not cancel a request in progress.

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception