org.kde.koala
Interface JobSignals

public interface JobSignals

Method Summary

void	connected(Job job) Emitted when the slave successfully connected to the host.
void	infoMessage(Job job, java.lang.String msg) Emitted to display information about this job, as sent by the slave.
void	percent(Job job, long percent) Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily.
void	processedSize(Job job, long size) Regularly emitted to show the progress of this job (current data size for transfers, entries listed).
void	result(Job job) Emitted when the job is finished, in any case (completed, canceled, failed...).
void	speed(Job job, long speed) Emitted to display information about the speed of this job.
void	totalSize(Job job, long size) Emitted when we know the size of this job (data size for transfers, number of entries for listings).
void	warning(Job job, java.lang.String msg) Emitted to display a warning about this job, as sent by the slave.

Method Detail

result

void result(Job job)

Emitted when the job is finished, in any case (completed, canceled, failed...). Use error to know the result.

Parameters:

job - the job that emitted this signal

infoMessage

void infoMessage(Job job,
                 java.lang.String msg)

Emitted to display information about this job, as sent by the slave. Examples of message are "Resolving host", "Connecting to host...", etc.

Parameters:

job - the job that emitted this signal

msg - the info message

warning

void warning(Job job,
             java.lang.String msg)

Emitted to display a warning about this job, as sent by the slave.

Parameters:

job - the job that emitted this signal

msg - the info message

connected

void connected(Job job)

Emitted when the slave successfully connected to the host. There is no guarantee the slave will send this, and this is currently unused (in the applications).

Parameters:

job - the job that emitted this signal

percent

void percent(Job job,
             long percent)

Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily. (see KProgress). Note that this signal is not emitted for finished jobs.

Parameters:

job - the job that emitted this signal

percent - the percentage

totalSize

void totalSize(Job job,
               long size)

Emitted when we know the size of this job (data size for transfers, number of entries for listings).

Parameters:

job - the job that emitted this signal

size - the total size in bytes

processedSize

void processedSize(Job job,
                   long size)

Regularly emitted to show the progress of this job (current data size for transfers, entries listed).

Parameters:

job - the job that emitted this signal

size - the processed size in bytes

speed

void speed(Job job,
           long speed)

Emitted to display information about the speed of this job.

Parameters:

job - the job that emitted this signal

speed - the speed in bytes/s