Service

class Cauldron.zmq.client.Service[source] [edit on github]

Bases: Cauldron.base.client.Service

A client-side KTL service object.

Parameters:
  • name – The KTL service name.
  • populate (bool) – Whether to pre-populate this KTL service with all of the known keys.

Services provide a dictionary-like access interface to KTL:

>>> svc = Service('myktl')          
>>> svc['mykey']                    
<Keyword service=myktl name=mykey>

Using dictionary indexing always returns a Keyword object.

Methods Summary

has_keyword(name) Determines if this service has a keyword.
keywords() List all keywords available in this Service instance.
shutdown() An explicity shutdown method.

Methods Documentation

has_keyword(name)[source] [edit on github]

Determines if this service has a keyword.

keyword can be either a Keyword instance, or a case-insensitive string.

This is an abstract method. Backends must implement this method

keywords()[source] [edit on github]

List all keywords available in this Service instance.

This is an abstract method. Backends must implement this method

shutdown()[source] [edit on github]

An explicity shutdown method.