com.dsi.ant.plugins.antplus.common

Class AntFsCommon.IpcDefines

java.lang.Object

com.dsi.ant.plugins.antplus.common.AntFsCommon.IpcDefines

Enclosing class:

AntFsCommon

public class AntFsCommon.IpcDefines
extends java.lang.Object

Defines the keys and values used to communicate between the PCC and plugin. User code should never have to reference these defines.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_CMD_ANTFSREQUEST_GENERIC_PARAM_boolUSEANTFSPROGRESSUPDATES If true, notifies the plugin to send progress updates.
static java.lang.String	MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_intSTATECODE The current AntFsCommon.AntFsStateCode.
static java.lang.String	MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTOTALBYTES The total number of bytes to be transferred.
static java.lang.String	MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTRANSFERREDBYTES The number of bytes transferred.
static java.lang.String	MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_arrayByteRAWFILEBYTES The bytes downloaded.
static java.lang.String	MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_longTARGETBYTES The target number of bytes requested.
static int	MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE Communicates the work done.
static int	MSG_EVENT_ANTFS_whatDOWNLOADFINISHED Receives files that have finished downloading

Constructor Summary

Constructors

Constructor and Description
AntFsCommon.IpcDefines()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE

public static final int MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE

Communicates the work done.

See Also:

Constant Field Values

MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_intSTATECODE

public static final java.lang.String MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_intSTATECODE

The current AntFsCommon.AntFsStateCode. Sent in the MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE event.

See Also:

Constant Field Values

MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTRANSFERREDBYTES

public static final java.lang.String MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTRANSFERREDBYTES

The number of bytes transferred. Sent in the MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE event. Note: There are cases in the process of retrying a download that this number can restart at a lower value. This number is always the progress towards the total, not a count of total number of bytes sent over the connection.

See Also:

Constant Field Values

MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTOTALBYTES

public static final java.lang.String MSG_EVENT_ANTFS_ANTFSPROGRESSUPDATE_PARAM_longTOTALBYTES

The total number of bytes to be transferred. Sent in the MSG_EVENT_ANTFS_whatANTFSPROGRESSUPDATE event.

See Also:

Constant Field Values

MSG_CMD_ANTFSREQUEST_GENERIC_PARAM_boolUSEANTFSPROGRESSUPDATES

public static final java.lang.String MSG_CMD_ANTFSREQUEST_GENERIC_PARAM_boolUSEANTFSPROGRESSUPDATES

If true, notifies the plugin to send progress updates.

See Also:

Constant Field Values

MSG_EVENT_ANTFS_whatDOWNLOADFINISHED

public static final int MSG_EVENT_ANTFS_whatDOWNLOADFINISHED

Receives files that have finished downloading

See Also:

Constant Field Values

MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_arrayByteRAWFILEBYTES

public static final java.lang.String MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_arrayByteRAWFILEBYTES

The bytes downloaded. Sent in the MSG_EVENT_ANTFS_whatDOWNLOADFINISHED event.

See Also:

Constant Field Values

MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_longTARGETBYTES

public static final java.lang.String MSG_EVENT_ANTFS_FILEDOWNLOADED_PARAM_longTARGETBYTES

The target number of bytes requested. If this does not match the size of the file bytes array it indicates the partial result of a failed download. Sent in the MSG_EVENT_ANTFS_whatDOWNLOADFINISHED event.

See Also:

Constant Field Values

Constructor Detail

AntFsCommon.IpcDefines

public AntFsCommon.IpcDefines()