Requester::SlowRequester Class Reference

Super class for requesters that perform some slow, non-CPU-intense operation like starting a system command and wait for output, do some communication via TCP/IP, or the like. More...

Inheritance diagram for Requester::SlowRequester:

List of all members.

Public Object Methods
	TCP_port (scalar port)
	command (scalar command)
	timeout (scalar timeout)
	getinfo (arrayref gets, arrayref indexes)
	Called by the default request() method with gets set to the list of the variables, indexes set to the list of variable indexes to be retrieved.
	criticalness (scalar criticalness)
	returns criticalness of the handler
	consumes (scalar consumes)
	returns consumes of the handler
	startup (scalar gets, scalar indexes)
	open a connection / start a command / whatever and return a file handle
	setup (scalar srq, scalar gets, scalar indexes)
	called immediately before SlowReqWorker takes over setup() may copy any volatile data (like "env") over into the $srq object
	do (scalar srq)
	do one step - read data via $srq->read(), $srq->readln() or write data via $srq->write(), call $srq->status() if finished
	error (scalar srq)
	called if an error condition (e.g.

---

Detailed Description

Super class for requesters that perform some slow, non-CPU-intense operation like starting a system command and wait for output, do some communication via TCP/IP, or the like.

---

Member Function Documentation

Requester::SlowRequester::command (  scalar  command  )

Requester::SlowRequester::consumes (  scalar  consumes  )

returns consumes of the handler

Requester::SlowRequester::criticalness (  scalar  criticalness  )

returns criticalness of the handler

Requester::SlowRequester::do (  scalar  srq  )

do one step - read data via $srq->read(), $srq->readln() or write data via $srq->write(), call $srq->status() if finished Reimplemented in Requester::expedap, Requester::nut, and Requester::solswap.

Requester::SlowRequester::error (  scalar  srq  )

called if an error condition (e.g. lost connection) is detected

Requester::SlowRequester::getinfo (  arrayref  gets, arrayref  indexes )

Called by the default request() method with gets set to the list of the variables, indexes set to the list of variable indexes to be retrieved. If gets or indexes are undefined, this means that a 'walk' through all the possible variables has to be performed. The default behaviour is to call the getwalk() method with an empty walks list. So, a requester implementation has to implement at least one of request(), getinfo() or getwalk() in order to do something useful. Parameters: gets  The list of names of the variables that have to be retrieved. indexes  The list of variable indexes that have to be retrieved. Returns: A folded hashref, at the first level the hashref uses the variable index as key, the values each point to a hashref with the name of the respective variable as a key, the scalar value as the value. Reimplemented from Requester::Requester. Reimplemented in Requester::expedap.

Requester::SlowRequester::setup (  scalar  srq, scalar  gets, scalar  indexes )

called immediately before SlowReqWorker takes over setup() may copy any volatile data (like "env") over into the $srq object Reimplemented in Requester::nut.

Requester::SlowRequester::startup (  scalar  gets, scalar  indexes )

open a connection / start a command / whatever and return a file handle Reimplemented in Requester::ping.

Requester::SlowRequester::TCP_port (  scalar  port  )

Requester::SlowRequester::timeout (  scalar  timeout  )

---

The documentation for this class was generated from the following file:

• uxmon/Requester/SlowRequester.pm

---