Package apama :: Module common :: Class ApamaServerProcess
[hide private]
[frames] | no frames]

Class ApamaServerProcess

source code

object --+
         |
        ApamaServerProcess
Known Subclasses:

Abstract parent helper class for Apama server processes.

Instance Methods [hide private]
 
__init__(self, parent, name, port=None, host=None)
Create an instance of the class.
source code
 
__repr__(self)
repr(x)
source code
 
manage(self, arguments=[], displayName='manage', **xargs)
Execute component_management operations against the process.
source code
 
running(self)
Returns True if this has a local process that is running, or False if it has stopped, or was not started by this object.
source code
 
shutdown(self, message='Shutdown requested by test', timeout=60, **args)
Requests a clean shutdown of the component.
source code
 
waitForComponentUp(self, timeout=60, **xargs)
Block until the the component declares itself to be ready for processing.
source code

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

Instance Variables [hide private]
dictionary environ
The environment for running the process
string host
Hostname for interaction with a remote process
pysys.basetest parent
Reference to the PySys testcase instantiating this class instance
integer port
Port used for starting and interaction with the process
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, parent, name, port=None, host=None)
(Constructor)

source code 

Create an instance of the class.

If no port parameter is used in the argument list an available port will be dynamically found from the OS and used for starting the process, and performing all operations against it. The host parameter is only used to perform operations against a remote process started externally to the PySys framework - the class does not support the starting of a remote process.

Parameters:
  • parent - Reference to the parent PySys testcase
  • port - The port used for starting and interacting with the Correlator
  • host - The hostname used for interaction with a remote Correlator
Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

manage(self, arguments=[], displayName='manage', **xargs)

source code 

Execute component_management operations against the process.

Parameters:
  • arguments - The arguments to be passed to component_management
  • xargs - Optional startProcess keyword arguments, e.g. timeout, ignoreExitStatus, arguments, workingDir

shutdown(self, message='Shutdown requested by test', timeout=60, **args)

source code 

Requests a clean shutdown of the component.

If it was started by this object, also waits for the process to terminate, and silently ignores requests to shutdown if the process was already stopped.