### Navigation

- index
- modules |
- next |
- previous |
- IPython v0.10.1 documentation »
- The IPython API »

# kernel.enginefc

## Module: `kernel.enginefc`

Inheritance diagram for `IPython.kernel.enginefc`:

Expose the IPython EngineService using the Foolscap network protocol.

Foolscap is a high-performance and secure network protocol.

## Classes

### `EngineFromReference`

class `IPython.kernel.enginefc.``EngineFromReference`(reference)

  Bases: `object`

  Adapt a RemoteReference to an IEngineBase implementing object.

  When an engine connects to a controller, it calls the register_engine method of the controller and passes the controller a RemoteReference to itself. This class is used to adapt this RemoteReference to an object that implements the full IEngineBase interface.

  See the documentation of IEngineBase for details on the methods.

  `__init__`()
  `callRemote`()
  `checkReturnForFailure`()

    See if a returned value is a pickled Failure object.

    To distinguish between general pickled objects and pickled Failures, the other side should prepend the string FAILURE: to any pickled Failure.

  `clear_properties`()
  `del_properties`()
  `execute`()
  `get_id`()

    Return the Engines id.

  `get_properties`()
  `get_result`()
  `has_properties`()
  `id`

    Return the Engines id.

  `keys`()
  `kill`()
  `killBack`()
  `properties`
  `pull`()
  `pull_function`()
  `pull_serialized`()
  `push`()
  `push_function`()
  `push_serialized`()

    Older version of pushSerialize.

  `reset`()
  `set_id`()

    Set the Engines id.

  `set_properties`()
  `syncProperties`()

### `FCEngineReferenceFromService`

class `IPython.kernel.enginefc.``FCEngineReferenceFromService`(service)

  Bases: `foolscap.referenceable.Referenceable`, `object`

  Adapt an IEngineBase to an IFCEngine implementer.

  This exposes an IEngineBase to foolscap by adapting it to a foolscap.Referenceable.

  See the documentation of the IEngineBase methods for more details.

  `__init__`()
  `remote_clear_properties`()
  `remote_del_properties`()
  `remote_execute`()
  `remote_get_id`()
  `remote_get_properties`()
  `remote_get_result`()
  `remote_has_properties`()
  `remote_keys`()
  `remote_kill`()
  `remote_pull`()
  `remote_pull_function`()
  `remote_pull_serialized`()
  `remote_push`()
  `remote_push_function`()
  `remote_push_serialized`()
  `remote_reset`()
  `remote_set_id`()
  `remote_set_properties`()

### `FCRemoteEngineRefFromService`

class `IPython.kernel.enginefc.``FCRemoteEngineRefFromService`(service)

  Bases: `foolscap.referenceable.Referenceable`

  Adapt an IControllerBase to an IFCControllerBase.

  `__init__`()
  `remote_register_engine`()

### `IFCControllerBase`

class `IPython.kernel.enginefc.``IFCControllerBase`(name, bases=(), attrs=None, __doc__=None, __module__=None)

  Bases: `zope.interface.Interface`

  Interface that tells how an Engine sees a Controller.

  In our architecture, the Controller listens for Engines to connect and register. This interface defines that registration method as it is exposed over the Foolscap network protocol

  classmethod `__init__`()

### `IFCEngine`

class `IPython.kernel.enginefc.``IFCEngine`(name, bases=(), attrs=None, __doc__=None, __module__=None)

  Bases: `zope.interface.Interface`

  An interface that exposes an EngineService over Foolscap.

  The methods in this interface are similar to those from IEngine, but their arguments and return values slightly different to reflect that FC cannot send arbitrary objects. We handle this by pickling/ unpickling that the two endpoints.

  If a remote or local exception is raised, the appropriate Failure will be returned instead.

  classmethod `__init__`()

### Navigation

- index
- modules |
- next |
- previous |
- IPython v0.10.1 documentation »
- The IPython API »