hsh :: jobs :: ExternalJob :: Class ExternalJob
[hide private]
[frames] | no frames]

Class ExternalJob

object --+    
         |    
       Job --+
             |
            ExternalJob

A Job which executes an external command.

Instance Methods [hide private]
 
start(self)
 
do_exclusive(self, start_proc=True)
Run the job in exclusive mode.
 
suspend(self)
Suspend the job.
 
can_send_input(self)
 
send_input(self, inp)
Send the provided text as input to the job.
 
close_input(self)
Close the input stream to this job.

Inherited from Job: __init__, get_directives, get_output, get_retcode, get_state, register_listener, unregister_listener

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from Job: create_job

Static Methods [hide private]

Inherited from Job: load_job

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

start(self)

 
Overrides: Job.start

do_exclusive(self, start_proc=True)

 

Run the job in exclusive mode. This function will block until the job terminates, or its process is stopped. The job will not be permitted to run until the display thread grants control over the terminal. If start_proc is True, then the job process will be started, otherwise it will be resumed with a CONT signal. A request will be sent to display this job before waiting for the terminal.

suspend(self)

 

Suspend the job. Send a STOP signal to it. This will only occur from a different thread of control from that running the job and communicates solely by sending a STOP signal to the job. The main thread takes responsibility for noticing that the job has stopped and changing object state.

can_send_input(self)

 
Overrides: Job.can_send_input

send_input(self, inp)

 

Send the provided text as input to the job. Jobs which can accept input will implement this.

Overrides: Job.send_input
(inherited documentation)

close_input(self)

 

Close the input stream to this job. Job subclasses may implement this.

Overrides: Job.close_input
(inherited documentation)