Package SpecClient :: Module SpecWaitObject

Module SpecWaitObject

SpecWaitObject module

This module defines the classes for helper objects designed for waiting specific events from Spec

Classes: SpecWaitObject -- base class for Wait objects

Functions: waitChannel -- wait for a channel update waitReply -- wait for a reply waitConnection -- wait for a connection

Version: 1.0

Author: Matias Guijarro

Classes

[hide private]

SpecWaitObject
Helper class for waiting specific events from Spec

Functions

[hide private]

waitFunc(timeout)
Waiting function

source code

waitConnection(connection, timeout=None)
Wait for a connection to Spec to be established

source code

waitChannelUpdate(chanName, connection, waitValue=None, timeout=None)
Wait for a channel to be updated

source code

waitReply(connection, command, argsTuple, timeout=None)
Wait for a reply from a remote Spec server

source code

Variables

[hide private]

__package__ = 'SpecClient'

Function Details

[hide private]

waitFunc(timeout)

source code

Waiting function

Arguments: timeout -- waiting time in milliseconds

waitConnection(connection, timeout=None)

source code

Wait for a connection to Spec to be established

Arguments: connection -- a 'host:port' string timeout -- optional timeout (defaults to None)

waitChannelUpdate(chanName, connection, waitValue=None, timeout=None)

source code

Wait for a channel to be updated

Arguments: chanName -- channel name (e.g 'var/toto') connection -- a 'host:port' string waitValue -- value to wait (defaults to None) timeout -- optional timeout (defaults to None)

waitReply(connection, command, argsTuple, timeout=None)

source code

Wait for a reply from a remote Spec server

Arguments: connection -- a 'host:port' string command -- command to execute argsTuple -- tuple of arguments for the command timeout -- optional timeout (defaults to None)