org.vishia.fileRemote

Class FileRemoteProgressEventConsumer

java.lang.Object

org.vishia.event.EventConsumerAwait<FileRemoteProgressEvData,FileRemoteCmdEventData>

org.vishia.fileRemote.FileRemoteProgressEventConsumer

All Implemented Interfaces:

EventConsumer

Direct Known Subclasses:

FileRemoteWalkerCallbackCopy, FileRemoteWalkerCallbackDelete

public class FileRemoteProgressEventConsumer
extends EventConsumerAwait<FileRemoteProgressEvData,FileRemoteCmdEventData>

This is the base class for all event consumer instances for progress actions which FileRemote calls. It is an EventConsumer and hence immediately usable for a EventWithDst with FileRemoteProgressEvData as payload.
An implementor overrides the #processEvent(FileRemoteProgressEvData, EventWithDst) to evaluate the progress information given in FileRemoteProgressEvData. It includes the PayloadBack.bDone to inform all is done and more.

Field Summary

Fields

Modifier and Type	Field and Description
int	nrDirAvail Number of available directories and files, filled on check.
int	nrFilesAvail Number of available directories and files, filled on check.
long	nrofBytesAllAvail
static java.lang.String	version Version, history and license.

Fields inherited from class org.vishia.event.EventConsumerAwait

bDone, cmdData, evBack, evThread, name, progressData, sError

Fields inherited from interface org.vishia.event.EventConsumer

mEventConsumed, mEventConsumerException, mEventConsumFinished, mEventDonotRelinquish, mMaskReservedHere

Constructor Summary

Constructors

Constructor and Description
FileRemoteProgressEventConsumer(java.lang.String name, EventThread_ifc progressThread, EventThread_ifc cmdThread) Constructs the FileRemoteProgress instance maybe also inherit.

Method Summary

Modifier and Type	Method and Description
FileRemoteProgressEventConsumer	clean() Cleans EventConsumerAwait.bDone and also EventConsumerAwait.sError.
void	setAvail(FileRemoteProgressEvData ev) This operation moves the gathered number of to the available numbers.

Methods inherited from class org.vishia.event.EventConsumerAwait

awaitExecution, done, evThread, processEvent, processEvent, setDone

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-07-24 refactored: renamed from FileRemoteProgress because the name has not show, it is a consumer. Some features are now contained in EventConsumerAwait in a common kind instead here.
• 2023-07-22 Hartmut new: now contains also the progressData and cmdData as reference and the event itself. but with change on 2023-07-24 consequently in the EventConsumerAwait super class. Hence it is a complete usable class for one event handling. This class is then only a concretion with non generics.
• 2023-03-12 Hartmut created as common solution for all FileRemote oriented event consumer.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

nrDirAvail

public int nrDirAvail

Number of available directories and files, filled on check.

nrFilesAvail

public int nrFilesAvail

Number of available directories and files, filled on check.

nrofBytesAllAvail

public long nrofBytesAllAvail

Constructor Detail

FileRemoteProgressEventConsumer

public FileRemoteProgressEventConsumer(java.lang.String name,
                                       EventThread_ifc progressThread,
                                       EventThread_ifc cmdThread)

Constructs the FileRemoteProgress instance maybe also inherit.

Parameters:

name - A name

progressThread - The thread where EventThread_ifc.storeEvent(EventObject) is called to store the event if it is used.

cmdThread - if given the using command is executed in this thread. If null then the command is executed in the own thread which calls the command.

Method Detail

clean

public FileRemoteProgressEventConsumer clean()

Description copied from class: EventConsumerAwait

Cleans EventConsumerAwait.bDone and also EventConsumerAwait.sError. It should be called on initializing the event, in any case before EventConsumerAwait.awaitExecution(long, boolean) was called.

Overrides:

clean in class EventConsumerAwait<FileRemoteProgressEvData,FileRemoteCmdEventData>

setAvail

public void setAvail(FileRemoteProgressEvData ev)

This operation moves the gathered number of to the available numbers. This is the necessary operation between prepare or mark, and the true action (for example copy). With that the progress in percent (proportional) can be shown).