host.anzo.eossdk.eos.sdk.titlestorage

Class EOS_TitleStorageFileTransferRequest

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.titlestorage.EOS_TitleStorageFileTransferRequest

All Implemented Interfaces:

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

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

Since:

8/31/2023

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOS_TITLESTORAGE_FILENAME_MAX_LENGTH_BYTES Maximum File Name Length in bytes

Constructor Summary

Constructors

Constructor and Description
EOS_TitleStorageFileTransferRequest()
EOS_TitleStorageFileTransferRequest(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()
EOS_EResult	getFilename(int filenameStringBufferSizeBytes, java.nio.ByteBuffer outStringBuffer, java.nio.IntBuffer outStringLength) Get the file name of the file this request is for.
EOS_EResult	getFileRequestState() Get the current state of a file request.
void	release()

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

Field Detail

EOS_TITLESTORAGE_FILENAME_MAX_LENGTH_BYTES

public static final int EOS_TITLESTORAGE_FILENAME_MAX_LENGTH_BYTES

Maximum File Name Length in bytes

See Also:

Constant Field Values

Constructor Detail

EOS_TitleStorageFileTransferRequest

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

EOS_TitleStorageFileTransferRequest

public EOS_TitleStorageFileTransferRequest()

Method Detail

getFileRequestState

public EOS_EResult getFileRequestState()

Get the current state of a file request.

Returns:

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

getFilename

public EOS_EResult getFilename(int filenameStringBufferSizeBytes,
                               java.nio.ByteBuffer outStringBuffer,
                               java.nio.IntBuffer outStringLength)

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.

Parameters:

filenameStringBufferSizeBytes - The maximum number of bytes that can be written to OutStringBuffer

outStringBuffer - The buffer to write the NULL-terminated utf8 file name into, if successful

outStringLength - How long the file name is (not including null terminator)

Returns:

EOS_EResult.EOS_Success if the file name was successfully written to OutFilenameBuffer, a failure result otherwise

See Also:

EOS_TITLESTORAGE_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()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception