All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.eNetwork.ECL.event.ECLXferListener

public interface ECLXferListener
The ECLXferListener interface can be used to implement an object which will receive the file transfer progress events, ECLXferEvent. Events are generated during file transfer as data buffers are transferred to or from the host.

To be notified of Xfer events, the application must:

  1. Define a class which implements the ECLXferListener interface.
  2. Implement the XferNotifyEvent(), XferNotifyStop(), and XferNotifyError() methods.
  3. Create an instance of the new class.
  4. Register the instance with the ECLXfer.RegisterXferEvent() method.

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

See Also:
ECLXfer

Method Index

 o XferNotifyError(ECLXfer, ECLErr)
The XferNotifyError() method is called whenever the ECLXfer object detects an error during event generation.
 o XferNotifyEvent(ECLXferEvent)
The XferNotifyEvent() method is called whenever a file data buffer has been successfully sent to or received from the host.
 o XferNotifyStop(ECLXfer, int)
The XferNotifyStop() method is called when event generation is stopped for any reason.

Methods

 o XferNotifyEvent
 public abstract void XferNotifyEvent(ECLXferEvent evt)
The XferNotifyEvent() method is called whenever a file data buffer has been successfully sent to or received from the host.

Parameters:
evt - The ECLXferEvent object.
 o XferNotifyStop
 public abstract void XferNotifyStop(ECLXfer xfer,
                                     int reason)
The XferNotifyStop() method is called when event generation is stopped for any reason. Event generation might stop because of an error condition or because the ECLXfer.UnregisterXferEvent() method was called.

Parameters:
xfer - The object which generated the event.
reason - This parameter is not currently used.
 o XferNotifyError
 public abstract void XferNotifyError(ECLXfer xfer,
                                      ECLErr err)
The XferNotifyError() method is called whenever the ECLXfer object detects an error during event generation. An ECLErr object containing information about the error is passed to this method. If event generation stops due to an error, the XferNotifyStop() method is also called.

Parameters:
xfer - The object which generated the event.
err - The ECLErr object containing error data.
See Also:
ECLErr, XferNotifyStop

All Packages  Class Hierarchy  This Package  Previous  Next  Index