Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • ExternalProcess
  • ExternalProcessFactory
  • LocalExternalProcess

Class LocalExternalProcess

Launches (local) tasks on a shell on the queue manager machine.

hrm\shell\ExternalProcess
Extended by hrm\shell\LocalExternalProcess
Namespace: hrm\shell
Package: hrm
Located at shell/LocalExternalProcess.php

Methods summary

public
# __construct( string $host, string $huscript_path, string $logfileName, string $errfileName )

LocalExternalProcess constructor.

LocalExternalProcess constructor.

Sets all shell pipes and file descriptors.

Parameters

$host
This is not used (is only passed on to the parent constructor).
$huscript_path
HuCore full executable.
$logfileName
Name of the process log (relative to the global $logdir).
$errfileName
Name of the process error log (relative to the global $logdir).

Overrides

hrm\shell\ExternalProcess::__construct
public boolean
# existsHuygensProcess( integer $pid )

Checks whether an Huygens Process with given Process IDentifier exists.

Checks whether an Huygens Process with given Process IDentifier exists.

Parameters

$pid
Process identifier as returned by the OS.

Returns

boolean
True if the process exists, false otherwise.

Todo

Refactor!

Overrides

hrm\shell\ExternalProcess::existsHuygensProcess
public string
# readFile( string $fileName )

Attempts to read a file, if existing.

Attempts to read a file, if existing.

Parameters

$fileName
The name of the file including its path.

Returns

string
The contents of the file in an array.

Overrides

hrm\shell\ExternalProcess::readFile
public boolean|
# copyFile2Host( string $fileName )

The function does not do anything, since there is no need to copy the file to a remote host.

The function does not do anything, since there is no need to copy the file to a remote host.

Parameters

$fileName
File name (ignored)

Returns

boolean|

Overrides

hrm\shell\ExternalProcess::copyFile2Host
public boolean
# isHuygensProcessSleeping( integer $pid )

Checks whether the Huygens Process with given Process IDentifier is sleeping.

Checks whether the Huygens Process with given Process IDentifier is sleeping.

Parameters

$pid
Process identifier as returned by the OS.

Returns

boolean
True if the process is sleeping, false otherwise. Always returns false.

Todo

Is it correct that this always return false?
Refactor: why is this saving to hrm_tmp?

Overrides

hrm\shell\ExternalProcess::isHuygensProcessSleeping
public
# rewakeHuygensProcess( integer $pid )

Wakes up the Huygens Process with given Process IDentifier.

Wakes up the Huygens Process with given Process IDentifier.

Parameters

$pid
Process identifier as returned by the OS.

Todo

This function is currenly doing nothing.

Overrides

hrm\shell\ExternalProcess::rewakeHuygensProcess
public boolean
# execute( string $command )

Executes a command.

Executes a command.

Parameters

$command
Command to be executed on the host.

Returns

boolean
True if the command was executed, false otherwise.

Todo

Why sleeping 5 seconds?

Overrides

hrm\shell\ExternalProcess::execute
public boolean
# ping( )

Pings the host.

Pings the host.

Returns

boolean
True always, since a machine should always be able to reach itself.

Overrides

hrm\shell\ExternalProcess::ping
public boolean
# runShell( )

Starts the shell.

Starts the shell.

Returns

boolean
True if the shell started successfully, false otherwise.

Overrides

hrm\shell\ExternalProcess::runShell

Methods inherited from hrm\shell\ExternalProcess

__destruct(), killHucoreChild(), killHucoreProcess(), pid(), release(), removeFile(), renameFile(), runHuygensTemplate()

Properties summary

Properties inherited from hrm\shell\ExternalProcess

$descriptorSpec, $errfileName, $host, $huscript_path, $logfileName, $out_file, $pid, $pipes, $shell

Huygens Remote Manager API documentation generated by ApiGen