StartStopStep
Bootstep that must be started and stopped in order.
Attributes
| Attribute | Type | Description |
|---|---|---|
| obj | object = null | Optional obj created by the :meth:create method. This is used by :class:StartStopStep to keep the original service object. |
Methods
start()
@classmethod
def start(
parent: Any
) - > Any
Starts the underlying service object if it has been initialized.
Parameters
| Name | Type | Description |
|---|---|---|
| parent | Any | The parent object or controller managing this bootstep's lifecycle. |
Returns
| Type | Description |
|---|---|
Any | The result of the service object's start method, or None if no object exists. |
stop()
@classmethod
def stop(
parent: Any
) - > Any
Stops the underlying service object if it has been initialized.
Parameters
| Name | Type | Description |
|---|---|---|
| parent | Any | The parent object or controller managing this bootstep's lifecycle. |
Returns
| Type | Description |
|---|---|
Any | The result of the service object's stop method, or None if no object exists. |
close()
@classmethod
def close(
parent: Any
) - > null
Performs cleanup operations for the step; currently implemented as a no-op.
Parameters
| Name | Type | Description |
|---|---|---|
| parent | Any | The parent object or controller managing this bootstep's lifecycle. |
Returns
| Type | Description |
|---|---|
null | Always returns None. |
terminate()
@classmethod
def terminate(
parent: Any
) - > Any
Attempts to terminate the underlying service object, falling back to the stop method if terminate is not defined.
Parameters
| Name | Type | Description |
|---|---|---|
| parent | Any | The parent object or controller managing this bootstep's lifecycle. |
Returns
| Type | Description |
|---|---|
Any | The result of the service object's terminate or stop method. |
include()
@classmethod
def include(
parent: Any
) - > boolean
Determines if the step should be included in the parent's execution chain and initializes the service object if so.
Parameters
| Name | Type | Description |
|---|---|---|
| parent | Any | The parent object or controller that maintains the list of active steps. |
Returns
| Type | Description |
|---|---|
boolean | True if the step was included and added to the parent's steps, False otherwise. |