Inherits from
- HasTraits: enthought.traits.has_traits.HasTraits
Attributes
- error
The client's error state (this is set to True after a failure to communicate with the server, or a failure on the server's part to communicate with this object's counterpart).
error = Bool(False)
- orphaned
The client's orphaned status
orphaned = Bool(True)
- other_type
other_type = Str
- registered
Whether this client has been registered with the Server. Note that this is not set after the 'register' method is called--it is set when the Server actually recieves the register command, which happens asynchronously.
registered = Bool(False)
- self_type
The type of this object and the type of the desired object, respectively
self_type = Str
- server_prefs
The preferences file path and node path to use for spawning a Server. If this is not specified it will not be possible for this Client, to spawn the server.
server_prefs = Tuple((os.path.join(remote_editor.__path__[0], 'preferences.ini'), 'enthought.remote_editor'), Str, Str)
- wx
Whether or not this client will be contained in a wx application. Failure to set this variable when appropriate will likely result in crashes.
wx = Bool(False)
Inherited from base classes
Method summary
- handle_command(self, command, arguments)
- register(self)
- send_command(self, command, arguments = '')
- unregister(self)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- handle_command(self, command, arguments)
This function should take a command string and an arguments string and do something with them. It should return True if the command given was understood; otherwise, False.
- register(self)
Inform the server that this Client is available to recieve commands.
- send_command(self, command, arguments = '')
Send a command to the server which is to be passed to an object of the appropriate type.
- unregister(self)
Inform the server that this Client is no longer available to recieve commands. Note that it is poor etiquette not to communicate when a Client is becoming unavailable. Calling 'unregister' when a Client is not registered has no effect.