Package host.anzo.eossdk.eos.sdk.playerdatastorage.callbackresults

Class EOS_PlayerDataStorage_ReadFileCallbackInfo

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.playerdatastorage.callbackresults.EOS_PlayerDataStorage_ReadFileCallbackInfo

Direct Known Subclasses:

EOS_PlayerDataStorage_ReadFileCallbackInfo.ByReference, EOS_PlayerDataStorage_ReadFileCallbackInfo.ByValue

@FieldOrder({"ResultCode","ClientData","LocalUserId","Filename"})
public class EOS_PlayerDataStorage_ReadFileCallbackInfo
extends com.sun.jna.Structure

Data containing the result of a read file request

Since:

8/22/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_PlayerDataStorage_ReadFileCallbackInfo.ByReference
static class	EOS_PlayerDataStorage_ReadFileCallbackInfo.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
com.sun.jna.Pointer	ClientData	Client-specified data passed into the file read request
String	Filename	The filename of the file that has been finished reading
EOS_ProductUserId	LocalUserId	The Product User ID of the local user who initiated this request
EOS_EResult	ResultCode	The result code for the operation. EOS_EResult.EOS_Success: The request was successful. EOS_EResult.EOS_Canceled: The request was canceled. EOS_EResult.EOS_TooManyRequests: There are too many requests in progress for the local user at this time. EOS_EResult.EOS_AlreadyPending: There is another requests in progress for the specified file by this user. EOS_EResult.EOS_CacheDirectoryMissing: The cache directory was not set when calling EOS_Platform_Create. EOS_EResult.EOS_CacheDirectoryInvalid: The cache directory provided when calling EOS_Platform_Create was invalid. EOS_EResult.EOS_PlayerDataStorage_UserThrottled: There were too many requests to the Data Storage service recently by the local user.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_PlayerDataStorage_ReadFileCallbackInfo()
EOS_PlayerDataStorage_ReadFileCallbackInfo(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

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

Field Details

ResultCode

public EOS_EResult ResultCode

The result code for the operation.
EOS_EResult.EOS_Success: The request was successful.
EOS_EResult.EOS_Canceled: The request was canceled.
EOS_EResult.EOS_TooManyRequests: There are too many requests in progress for the local user at this time.
EOS_EResult.EOS_AlreadyPending: There is another requests in progress for the specified file by this user.
EOS_EResult.EOS_CacheDirectoryMissing: The cache directory was not set when calling EOS_Platform_Create.
EOS_EResult.EOS_CacheDirectoryInvalid: The cache directory provided when calling EOS_Platform_Create was invalid.
EOS_EResult.EOS_PlayerDataStorage_UserThrottled: There were too many requests to the Data Storage service recently by the local user. The application must wait some time before trying again.
EOS_EResult.EOS_PlayerDataStorage_EncryptionKeyNotSet: The encryption key value was not set when calling EOS_Platform_Create.
EOS_EResult.EOS_PlayerDataStorage_FileCorrupted: The downloaded or cached file was corrupted or invalid in some way. What exactly is wrong with the file is returned in the logs (potentially retryable).
EOS_EResult.EOS_InvalidState: The read operation is not allowed (e.g. when application is suspended).
EOS_EResult.EOS_UnexpectedError: An unexpected error occurred either downloading, or reading the downloaded file. This most commonly means there were file IO issues such as: permission issues, disk is full, etc. (potentially retryable)

ClientData

public com.sun.jna.Pointer ClientData

Client-specified data passed into the file read request

LocalUserId

public EOS_ProductUserId LocalUserId

The Product User ID of the local user who initiated this request

Filename

public String Filename

The filename of the file that has been finished reading

Constructor Details

EOS_PlayerDataStorage_ReadFileCallbackInfo

public EOS_PlayerDataStorage_ReadFileCallbackInfo()

EOS_PlayerDataStorage_ReadFileCallbackInfo

public EOS_PlayerDataStorage_ReadFileCallbackInfo(com.sun.jna.Pointer peer)