All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.event.ECLXferEvent

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.event.ECLEvent
           |
           +----com.ibm.eNetwork.ECL.event.ECLProgressEvent
                   |
                   +----com.ibm.eNetwork.ECL.event.ECLXferEvent

public class ECLXferEvent
extends ECLProgressEvent
Event fired to notify listeners of progress during file transfers.

HOD-uniqueECLXferEvents are only generated in Host On-Demand.


Constructor Index

 o ECLXferEvent(Object, long, long, String, String, boolean)
Constructor for generating a new ECLXferEvent.
 o ECLXferEvent(Object, long, long, String, String, boolean, int)
Constructor for generating a new ECLXferEvent.
 o ECLXferEvent(Object, long, String, String, boolean)
Constructor for generating a new ECLXferEvent when the size of the file is not known.
 o ECLXferEvent(Object, long, String, String, boolean, int)
Constructor for generating a new ECLXferEvent when the size of the file is not known.

Method Index

 o GetBytesSent()
Returns the total number of bytes sent.
 o GetBytesToSend()
Returns the total number of bytes to be sent.
 o GetECLXfer()
Returns the instance of ECLXfer associated with this event.
 o GetSourceFile()
Returns the source file for this transfer event.
 o GetTargetFile()
Returns the target file for this transfer event.
 o IsReceive()
Determines whether this event is for a receive or send operation.
 o toString()
Returns a String representation of the event.

Constructors

 o ECLXferEvent
 public ECLXferEvent(Object source,
                     long bytesSent,
                     String sourceFile,
                     String targetFile,
                     boolean receive)
Constructor for generating a new ECLXferEvent when the size of the file is not known.

Parameters:
source - The source of the event.
bytesSent - The number of bytes sent so far.
sourceFile - The source file for the transfer.
targetFile - The target file for the transfer.
receive - True if receiving, false if sending.
 o ECLXferEvent
 public ECLXferEvent(Object source,
                     long bytesSent,
                     String sourceFile,
                     String targetFile,
                     boolean receive,
                     int type)
Constructor for generating a new ECLXferEvent when the size of the file is not known.

Parameters:
source - The source of the event.
bytesSent - The number of bytes sent so far.
sourceFile - The source file for the transfer.
targetFile - The target file for the transfer.
receive - True if receiving, false if sending.
type - The type of event.
 o ECLXferEvent
 public ECLXferEvent(Object source,
                     long bytesSent,
                     long bytesToSend,
                     String sourceFile,
                     String targetFile,
                     boolean receive)
Constructor for generating a new ECLXferEvent.

Parameters:
source - The source of the event.
bytesSent - The number of bytes sent so far.
bytesToSend - The total number of bytes to be sent.
sourceFile - The source file for the transfer.
targetFile - The target file for the transfer.
receive - True if receiving, false if sending.
 o ECLXferEvent
 public ECLXferEvent(Object source,
                     long bytesSent,
                     long bytesToSend,
                     String sourceFile,
                     String targetFile,
                     boolean receive,
                     int type)
Constructor for generating a new ECLXferEvent.

Parameters:
source - The source of the event.
bytesSent - The number of bytes sent so far.
bytesToSend - The total number of bytes to be sent.
sourceFile - The source file for the transfer.
targetFile - The target file for the transfer.
receive - True if receiving, false if sending.
type - The type of event.

Methods

 o GetECLXfer
 public ECLXfer GetECLXfer()
Returns the instance of ECLXfer associated with this event.

 o GetSourceFile
 public String GetSourceFile()
Returns the source file for this transfer event. If the event is for a receive operation, it is the name of the host file. If the event is for a send operation, it is the name of the local file.

 o GetTargetFile
 public String GetTargetFile()
Returns the target file for this transfer event. If the event is for a receive operation, it is the name of the local file. If the event is for a send operation, it is the name of the host file.

 o GetBytesSent
 public long GetBytesSent()
Returns the total number of bytes sent.

 o GetBytesToSend
 public long GetBytesToSend()
Returns the total number of bytes to be sent. If the size of a file is unknown or if the event is for a receive operation, this method will return -1.

 o IsReceive
 public boolean IsReceive()
Determines whether this event is for a receive or send operation.

Returns:
true if receiving, false if sending.
 o toString
 public String toString()
Returns a String representation of the event.

Overrides:
toString in class ECLEvent

All Packages  Class Hierarchy  This Package  Previous  Next  Index