xmlBlaster 2.2.0 API

org.xmlBlaster.util.xbformat
Interface I_ProgressListener

All Known Implementing Classes:
DispatchStatistic

public interface I_ProgressListener

This interface is used to inform listeners about incoming data.

Author:
Marcel Ruff.

Method Summary
 void clearCurrentReads()
          Used to clear current (ongoing) read operations.
 void clearCurrentWrites()
          Used to clear current (ongoing) write operations.
 void progressRead(java.lang.String name, long currBytesRead, long numBytes)
          Notification about the current data receive progress.
 void progressWrite(java.lang.String name, long currBytesWritten, long numBytes)
          Notification about the current data send progress.
 

Method Detail

progressRead

void progressRead(java.lang.String name,
                  long currBytesRead,
                  long numBytes)
Notification about the current data receive progress.

The interval of notification is arbitrary and not guaranteed, each protocol driver may choose other strategies.

Parameters:
name - A qualifying name about the incoming request, can be empty.
currBytesRead - The number of bytes received up to now
numBytes - The overall number of bytes

progressWrite

void progressWrite(java.lang.String name,
                   long currBytesWritten,
                   long numBytes)
Notification about the current data send progress.

The interval of notification is arbitrary and not guaranteed, each protocol driver may choose other strategies.

Parameters:
name - A qualifying name about the incoming request, can be empty.
currBytesWritten - The number of bytes send up to now
numBytes - The overall number of bytes

clearCurrentWrites

void clearCurrentWrites()
Used to clear current (ongoing) write operations. This is invoked if an exception occurs when writing.


clearCurrentReads

void clearCurrentReads()
Used to clear current (ongoing) read operations. This is invoked if an exception occurs when writing.


xmlBlaster 2.2.0 API

Copyright © 1999-2014 The xmlBlaster.org contributers.