• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

  • TDEIO
  • SimpleJob
Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
TDEIO::SimpleJob Class Reference

#include <jobclasses.h>

Inheritance diagram for TDEIO::SimpleJob:
TDEIO::Job TDEIO::ListJob TDEIO::LocalURLJob TDEIO::MkdirJob TDEIO::StatJob TDEIO::TransferJob TDEIO::DavJob TDEIO::MimetypeJob TDEIO::MultiGetJob TDEIO::StoredTransferJob

Public Slots

void slotTotalSize (TDEIO::filesize_t data_size)
 
virtual void slotError (int, const TQString &)
 

Public Member Functions

 SimpleJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo)
 
const KURL & url () const
 
virtual void kill (bool quietly=true)
 
virtual void putOnHold ()
 
virtual void start (Slave *slave)
 
void slaveDone ()
 
Slave * slave () const
 
int command () const
 
- Public Member Functions inherited from TDEIO::Job
int error () const
 
int progressId () const
 
const TQString & errorText () const
 
TQString errorString () const
 
TQStringList detailedErrorStrings (const KURL *reqUrl=0L, int method=-1) const
 
void showErrorDialog (TQWidget *parent=0L)
 
void setAutoErrorHandlingEnabled (bool enable, TQWidget *parentWidget=0)
 
bool isAutoErrorHandlingEnabled () const
 
void setAutoWarningHandlingEnabled (bool enable)
 
bool isAutoWarningHandlingEnabled () const
 
void setInteractive (bool enable)
 
bool isInteractive () const
 
void setWindow (TQWidget *window)
 
TQWidget * window () const
 
void updateUserTimestamp (unsigned long time)
 
void setParentJob (Job *parentJob)
 
Job * parentJob () const
 
void setMetaData (const TDEIO::MetaData &metaData)
 
void addMetaData (const TQString &key, const TQString &value)
 
void addMetaData (const TQMap< TQString, TQString > &values)
 
void mergeMetaData (const TQMap< TQString, TQString > &values)
 
MetaData outgoingMetaData () const
 
MetaData metaData () const
 
TQString queryMetaData (const TQString &key)
 
TDEIO::filesize_t getProcessedSize ()
 

Static Public Member Functions

static void removeOnHold ()
 

Protected Slots

virtual void slotFinished ()
 
void slotWarning (const TQString &)
 
void slotInfoMessage (const TQString &s)
 
void slotConnected ()
 
void slotProcessedSize (TDEIO::filesize_t data_size)
 
void slotSpeed (unsigned long speed)
 
virtual void slotMetaData (const TDEIO::MetaData &_metaData)
 
void slotNeedProgressId ()
 
- Protected Slots inherited from TDEIO::Job
virtual void slotResult (TDEIO::Job *job)
 
void slotSpeed (TDEIO::Job *job, unsigned long speed)
 
void slotInfoMessage (TDEIO::Job *job, const TQString &msg)
 
void slotSpeedTimeout ()
 

Protected Member Functions

virtual void virtual_hook (int id, void *data)
 
void storeSSLSessionFromJob (const KURL &m_redirectionURL)
 
- Protected Member Functions inherited from TDEIO::Job
 Job (bool showProgressInfo)
 
virtual void addSubjob (Job *job, bool inheritMetaData=true)
 
virtual void removeSubjob (Job *job)
 
void removeSubjob (Job *job, bool mergeMetaData, bool emitResultIfLast)
 
void emitPercent (TDEIO::filesize_t processedSize, TDEIO::filesize_t totalSize)
 
void emitSpeed (unsigned long speed)
 
void emitResult ()
 
void setProcessedSize (TDEIO::filesize_t size)
 
unsigned long userTimestamp () const
 
int & extraFlags ()
 

Protected Attributes

Slave * m_slave
 
TQByteArray m_packedArgs
 
KURL m_url
 
KURL m_subUrl
 
int m_command
 
TDEIO::filesize_t m_totalSize
 
- Protected Attributes inherited from TDEIO::Job
TQPtrList< Job > subjobs
 
int m_error
 
TQString m_errorText
 
unsigned long m_percent
 
int m_progressId
 
TQTimer * m_speedTimer
 
TQGuardedPtr< TQWidget > m_window
 
MetaData m_outgoingMetaData
 
MetaData m_incomingMetaData
 

Additional Inherited Members

- Signals inherited from TDEIO::Job
void result (TDEIO::Job *job)
 
void canceled (TDEIO::Job *job)
 
void infoMessage (TDEIO::Job *job, const TQString &msg)
 
void warning (TDEIO::Job *job, const TQString &msg)
 
void connected (TDEIO::Job *job)
 
void percent (TDEIO::Job *job, unsigned long percent)
 
void totalSize (TDEIO::Job *job, TDEIO::filesize_t size)
 
void processedSize (TDEIO::Job *job, TDEIO::filesize_t size)
 
void speed (TDEIO::Job *job, unsigned long speed)
 
- Protected Types inherited from TDEIO::Job
enum  { EF_TransferJobAsync = (1 << 0) , EF_TransferJobNeedData = (1 << 1) , EF_TransferJobDataSent = (1 << 2) , EF_ListJobUnrestricted = (1 << 3) }
 

Detailed Description

A simple job (one url and one command).

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (CopyJob, DeleteJob, FileCopyJob...) that manage subjobs but aren't scheduled directly.

Definition at line 527 of file jobclasses.h.

Constructor & Destructor Documentation

◆ SimpleJob()

SimpleJob::SimpleJob ( const KURL &  url,
int  command,
const TQByteArray &  packedArgs,
bool  showProgressInfo 
)

Creates a new simple job.

You don't need to use this constructor, unless you create a new job that inherits from SimpleJob.

Parameters
urlthe url of the job
commandthe command of the job
packedArgsthe arguments
showProgressInfotrue to show progress information to the user

Definition at line 459 of file job.cpp.

Member Function Documentation

◆ kill()

void SimpleJob::kill ( bool  quietly = true)
virtual

Abort job.

This kills all subjobs and deletes the job.

Parameters
quietlyif true, Job will emit signal result Should only be set to false when the user kills the job (from tdeio_uiserver), not when you want to abort a job.

Reimplemented from TDEIO::Job.

Definition at line 486 of file job.cpp.

◆ putOnHold()

void SimpleJob::putOnHold ( )
virtual

Abort job.

Suspends slave to be reused by another job for the same request.

Definition at line 493 of file job.cpp.

◆ removeOnHold()

void SimpleJob::removeOnHold ( )
static

Discard suspended slave.

Definition at line 504 of file job.cpp.

◆ slotConnected

void SimpleJob::slotConnected ( )
protectedslot
Called on a slave's connected signal.
See also
connected()

Definition at line 668 of file job.cpp.

◆ slotFinished

void SimpleJob::slotFinished ( )
protectedvirtualslot

Called when the slave marks the job as finished.

Definition at line 605 of file job.cpp.

◆ slotInfoMessage

void SimpleJob::slotInfoMessage ( const TQString &  s)
protectedslot
Called on a slave's info message.
Parameters
sthe info message
See also
infoMessage()

Definition at line 663 of file job.cpp.

◆ slotMetaData

void SimpleJob::slotMetaData ( const TDEIO::MetaData &  _metaData)
protectedvirtualslot
MetaData from the slave is received.
Parameters
_metaDatathe meta data
See also
metaData()

Definition at line 706 of file job.cpp.

◆ slotProcessedSize

void SimpleJob::slotProcessedSize ( TDEIO::filesize_t  data_size)
protectedslot
Forward signal from the slave.
Parameters
data_sizethe processed size in bytes
See also
processedSize()

Definition at line 689 of file job.cpp.

◆ slotSpeed

void SimpleJob::slotSpeed ( unsigned long  speed)
protectedslot
Forward signal from the slave.
Parameters
speedthe speed in bytes/s
See also
speed()

Definition at line 700 of file job.cpp.

◆ slotTotalSize

void SimpleJob::slotTotalSize ( TDEIO::filesize_t  data_size)
slot
Forward signal from the slave
Can also be called by the parent job, when it knows the size.
Parameters
data_sizethe total size

Definition at line 680 of file job.cpp.

◆ url()

const KURL& TDEIO::SimpleJob::url ( ) const
inline

Returns the SimpleJob's URL.

Returns
the url

Definition at line 548 of file jobclasses.h.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.9.1
This website is maintained by Timothy Pearson.