host.anzo.eossdk.eos.sdk.titlestorage.options

Class EOS_TitleStorage_ReadFileOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.titlestorage.options.EOS_TitleStorage_ReadFileOptions

Direct Known Subclasses:

EOS_TitleStorage_ReadFileOptions.ByReference, EOS_TitleStorage_ReadFileOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","LocalUserId","Filename","ReadChunkLengthBytes","ReadFileDataCallback","FileTransferProgressCallback"})
public class EOS_TitleStorage_ReadFileOptions
extends com.sun.jna.Structure

Input data for the EOS_TitleStorage_ReadFile function

Since:

9/3/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_TitleStorage_ReadFileOptions.ByReference
static class	EOS_TitleStorage_ReadFileOptions.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 and Description
int	ApiVersion API Version: Set this to EOS_TITLESTORAGE_READFILE_API_LATEST.
static int	EOS_TITLESTORAGE_READFILE_API_LATEST The most recent version of the EOS_TitleStorage_ReadFile API.
java.lang.String	Filename The file name to read; this file must already exist
EOS_TitleStorage_OnFileTransferProgressCallback	FileTransferProgressCallback Optional callback function to be informed of download progress, if the file is not already locally cached.
EOS_ProductUserId	LocalUserId Product User ID of the local user who is reading the requested file (optional)
int	ReadChunkLengthBytes The maximum amount of data in bytes should be available to read in a single EOS_TitleStorage_OnReadFileDataCallback call
EOS_TitleStorage_OnReadFileDataCallback	ReadFileDataCallback Callback function to handle copying read data

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_TitleStorage_ReadFileOptions()
EOS_TitleStorage_ReadFileOptions(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 Detail

EOS_TITLESTORAGE_READFILE_API_LATEST

public static final int EOS_TITLESTORAGE_READFILE_API_LATEST

The most recent version of the EOS_TitleStorage_ReadFile API.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_TITLESTORAGE_READFILE_API_LATEST.

LocalUserId

public EOS_ProductUserId LocalUserId

Product User ID of the local user who is reading the requested file (optional)

Filename

public java.lang.String Filename

The file name to read; this file must already exist

ReadChunkLengthBytes

public int ReadChunkLengthBytes

The maximum amount of data in bytes should be available to read in a single EOS_TitleStorage_OnReadFileDataCallback call

ReadFileDataCallback

public EOS_TitleStorage_OnReadFileDataCallback ReadFileDataCallback

Callback function to handle copying read data

FileTransferProgressCallback

public EOS_TitleStorage_OnFileTransferProgressCallback FileTransferProgressCallback

Optional callback function to be informed of download progress, if the file is not already locally cached. If set, this will be called at least once before completion if the request is successfully started

Constructor Detail

EOS_TitleStorage_ReadFileOptions

public EOS_TitleStorage_ReadFileOptions()

EOS_TitleStorage_ReadFileOptions

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