Skip to main content
Version: v19 R8 BETA

SystemWorker

Os trabalhadores do sistema permitem que o código 4D chame qualquer processo externo (um comando shell, PHP, etc.) na mesma máquina. Os trabalhadores do sistema são chamados assíncronos. Ao utilizar os callbacks, 4D torna possível a comunicação de ambas as maneiras.

A classe SystemWorker está disponível na loja de classes 4D .

Exemplo

    // Windows example to get access to the ipconfig information
var $myWinWorker : 4D. SystemWorker
var $ipConfig : Text
$myWinWorker:= 4D. SystemWorker.new("ipconfig")
$ipConfig:=$myWinWorker.wait(1).response //timeout 1 second

// macOS example to change the permissions for a file on macOS
// chmod is the macOS command used to modify file access
var $myMacWorker : 4D. SystemWorker
$myMacWorker:= 4D. SystemWorker.new("chmod +x /folder/myfile.sh")

Resumo

4D. SystemWorker.new ( commandLine : Text { ; options : Object } ) : 4D. SystemWorker    contains the command line passed as parameter to the new() function
.closeInput()    fecha o fluxo de entrada (stdin) do processo externo
.commandLine : Text    contains the working directory in which the external process is executed
.currentDirectory : 4D. Folder    contains the process unique identifier of the external process at the system level
.dataType : Text    contém o tipo de conteúdo do corpo de resposta
.encoding : Text    contém a codificação do conteúdo do corpo de resposta
.errors : Collection    contém uma colecção de erros 4D em caso de erro(s) de execução
.exitCode : Integer    contém o código de saída devolvido pelo processo externo
.hideWindow : Booleano    pode ser usado para esconder a janela da consola DOS ou a janela do executável lançado (Windows only)
.pid : Integer    contains true if the external process is terminated
.postMessage( message : Text)
.postMessage( messageBLOB : Blob)
    permite escrever no fluxo de entrada (stdin) do processo externo
.response : Text
.response : Blob
    contém a concatenação de todos os dados devolvidos uma vez terminado o pedido
.responseError : Text    contém a concatenação de todos os erros devolvidos, uma vez terminado o pedido
.terminate()    The .terminate() function
.terminado : Booleano    contains the duration in seconds before the external process will be killed if it is still alive
.timeout : Integer    waits until the end of the SystemWorker execution or the specified timeout
.wait( {timeout : Real} ) : 4D. SystemWorker    espera até ao final do SystemWorker execução ou o tempo limite especificado **

4D. SystemWorker.new()

Histórico
VersãoMudanças
v19 R4Adicionado

4D. SystemWorker.new ( commandLine : Text { ; options : Object } ) : 4D. SystemWorker

ParâmetrosTipoDescrição
commandLineText->Linha de comando a executar
optionsObjeto->Parâmetros do trabalhador
result4D. SystemWorker<-Novo trabalhador do Sistema assíncrono ou nulo se o processo não for iniciado

Descrição

The .commandLine property contains the command line passed as parameter to the new() function.

O objecto worker do sistema devolvido pode ser utilizado para postar mensagens ao worker e obter a saída do worker.

Se ocorrer um erro durante a criação do objecto proxy, a função devolve um objecto null e é lançado um erro.

No parâmetro commandLine , passar o caminho completo do arquivo da aplicação a ser executado (sintaxe posix), bem como quaisquer argumentos necessários, se necessário. Se passar apenas o nome da aplicação, 4D utilizará a variável de ambiente PATH para localizar o executável.

Advertência: Esta função só pode lançar aplicações executáveis; não pode executar instruções que fazem parte da shell (intérprete de comandos). Por exemplo, sob Windows não é possível utilizar este comando para executar a instrução dir .

Objeto opções

No parâmetro opções , passe um objeto que possa conter as seguintes propriedades:

PropriedadeTipoPredefiniçãoDescrição
onResponseFormulaindefinidoChamada de retorno para mensagens de worker do sistema. Esta chamada de retorno é chamada assim que a resposta completa é recebida. It receives two objects as parameters (see below)
onDataFormulaindefinidoChamada de retorno para os dados do worker do sistema. Esta chamada de retorno é chamada cada vez que o worker do sistema recebe dados. It receives two objects as parameters (see below)
onDataErrorFormulaindefinidoChamada de retorno para os erros do processo externo (stderr do processo externo). It receives two objects as parameters (see below)
onErrorFormulaindefinidoChamada de retorno para erros de execução, devolvida pelo worker do sistema em caso de condições anormais de tempo de execução (erros de sistema). It receives two objects as parameters (see below)
onTerminateFormulaindefinidoChamada de retorno quando o processo externo é terminado. It receives two objects as parameters (see below)
timeoutNúmeroindefinidoTempo em segundos antes de o processo ser terminado se ainda estiver vivo
dataTypeText"text"Tipo de conteúdo do corpo de resposta. Possíveis valores: "texto" (por defeito), "bolha".
encodingText"UTF-8"Apenas se dataType="text". Codificação do conteúdo do corpo de resposta. Para a lista de valores disponíveis, ver a CONVERTA DO TEXTO descrição do comando
variablesObjetoDefine variáveis de ambiente personalizadas para o trabalhador do sistema. Sintaxe: variables.key=value, onde key é o nome da variável e valor o seu valor. Os valores são convertidos em cordas quando possível. O valor não pode conter um '='. Se não estiver definido, o trabalhador do sistema herda do ambiente 4D.
currentDirectoryFolderDirectório de trabalho em que o processo é executado
hideWindowBooleanotrue(Windows) Esconder a janela de aplicação (se possível) ou a consola Windows

Todas as funções de chamada de retorno recebem dois parâmetros de objectos. O seu conteúdo depende do retorno da chamada:

ParâmetrosTipoonResponseonDataonDataErroronErroronTerminate
$param1ObjetoSystemWorkerSystemWorkerSystemWorkerSystemWorkerSystemWorker
$param2.typeText"response""data""erro""erro""termination"
$param2.dataText ou Blobdados recebidosdados de erro

Here is the sequence of callback calls:

  1. onData e onDataError são executados uma ou várias vezes
  2. se chamado, onError é executado uma vez (pára o processamento do trabalhador do sistema)
  3. se não ocorreu nenhum erro, onResponse é executado uma vez
  4. onTerminate é sempre executado

Valor retornado

A função devolve um objecto de trabalhador do sistema sobre o qual se pode chamar funções e propriedades da classe SystemWorker.

Exemplos no Windows

  1. Para abrir o Bloco de Notas e abrir um documento específico:
var $sw : 4D. SystemWorker
var $options : Object
$options:=New object
$options.hideWindow:= False

$sw:=4D. SystemWorker.new ("C:\\WINDOWS\\notepad.exe C:\\Docs\\new folder\\res.txt";$options)
  1. Executar npm instalar na consola:
var $folder : 4D. Folder
var $options : Object
var $worker : 4D. SystemWorker

$folder:=Folder(fk database folder)
$options:=New object
$options.currentDirectory:=$folder
$options.hideWindow:=False

$worker:=4D. SystemWorker.new("cmd /c npm install";$options)

  1. Para lançar a aplicação Microsoft® Word® e abrir um documento específico:
$mydoc:="C:\\Program Files\\Microsoft Office\\Office15\\WINWORD.EXE C:\\Tempo\\output.txt"
var $sw : 4D. SystemWorker
$sw:=4D. SystemWorker.new($mydoc)
  1. Para lançar um comando com o diretório atual e publicar uma mensagem:
var $param : Object
var $sys : 4D. SystemWorker

$param:=New object
$param.currentDirectory:=Folder(fk database folder)
$sys:=4D. SystemWorker.new("git commit -F -";$param)
$sys.postMessage("This is a postMessage")
$sys.closeInput()
  1. Para permitir que o utilizador abra um documento externo no Windows:
$docname:=Select document("";"*.*";"Choose the file to open";0)
If(OK=1)
var $sw : 4D. SystemWorker
$sw:=4D. SystemWorker.new("cmd.exe /C start \"\" \""+$docname+"\"")
End if

Exemplos em macOS

  1. Editar um arquivo de texto (cat é o comando macOS utilizado para editar arquivos). Neste exemplo, o caminho de acesso completo do comando é passado:

var $sw : 4D. SystemWorker
$sw:=4D. SystemWorker.new("/bin/cat /folder/myfile.txt")
$sw.wait() //synchronous execution

  1. Para lançar uma aplicação "gráfica" independente, é preferível utilizar o comando do sistema abrir (neste caso, o código tem o mesmo efeito que um duplo clique na aplicação):
var $sw : 4D. SystemWorker
$sw:=4D. SystemWorker.new ("open /Applications/Calculator.app")
  1. Para obter o conteúdo da pasta "Users" (ls -l é o equivalente em macOS do comando dir em DOS).
var $systemworker : 4D. SystemWorker
var $output : Text
var $errors : Collection

$systemworker:=4D. SystemWorker.new("/bin/ls -l /Users ")
$systemworker.wait(5)
$output:=$systemworker.response
$error:=$systemworker.errors

  1. O mesmo comando que acima, mas usando uma amostra de classe de utilizador "Params" para mostrar como lidar com as funções de callback:

var $systemworker : 4D. SystemWorker
$systemworker:=4D. SystemWorker.new("/bin/ls -l /Users ";cs. Params.new())


// "Params" class Class constructor
This.dataType:="text"
This.data:=""
This.dataError:="" Function onResponse($systemWorker : Object)
This._createFile("onResponse"; $systemWorker.response) Function onData($systemWorker : Object; $info : Object)
This.data+=$info.data
This._createFile("onData";this.data) Function onDataError($systemWorker : Object; $info : Object)
This.dataError+=$info.data
This._createFile("onDataError";this.dataError) Function onTerminate($systemWorker : Object)
var $textBody : Text
$textBody:="Response: "+$systemWorker.response
$textBody+="ResponseError: "+$systemWorker.responseError
This._createFile("onTerminate"; $textBody) Function _createFile($title : Text; $textBody : Text)
TEXT TO DOCUMENT(Get 4D folder(Current resources folder)+$title+".txt"; $textBody)

.closeInput()

Histórico
VersãoMudanças
v19 R4Adicionado

.closeInput()

ParâmetrosTipoDescrição
Não exige nenhum parâmetro

Descrição

A função .closeInput() fecha o fluxo de entrada (stdin) do processo externo.

Quando o executável espera que todos os dados sejam recebidos através de postMessage(), .closeInput() é útil para indicar ao executável que o envio de dados está terminado e que pode prosseguir.

Exemplo

// Create some data to gzip
var $input;$output : Blob
var $gzip : Text TEXT TO BLOB("Hello, World!";$input)
$gzip:="\"C:\\Program Files (x86)\\GnuWin32\\bin\\gzip.exe\" "

// Create an asynchronous system worker
var $worker : 4D. SystemWorker
$worker:= 4D. SystemWorker.new($gzip;New object("dataType";"blob"))

// Send the compressed file on stdin.
$worker.postMessage($input)
// Note que chamamos closeInput() para indicar que terminámos.
// gzip (e a maioria dos dados de espera do programa stdin) esperará por mais dados até que a entrada seja explícitamente fechada.
$worker.closeInput()
$worker.wait()

$output:=$worker.response

.commandLine

.commandLine : Text

Descrição

The .currentDirectory property contains the working directory in which the external process is executed.

Essa propriedade é apenas leitura.

.currentDirectory

.currentDirectory : 4D. Folder

Descrição

The .pid property contains the process unique identifier of the external process at the system level.

.dataType

.dataType : Text

Descrição

A propriedade .dataType contém o tipo de conteúdo do corpo de resposta. .

Essa propriedade é apenas leitura.

.encoding

.encoding : Text

Descrição

A propriedade .encoding contém a codificação do conteúdo do corpo de resposta. .

Essa propriedade é apenas leitura.

.errors

.errors : Collection

Descrição

A propriedade .erros contém uma colecção de erros 4D em caso de erro(s) de execução.

Cada elemento da coleção é um objeto com as seguintes propriedades:

PropriedadeTipoDescrição
[].errorCodenumber4D error code
[].messagetextDescription of the 4D error
[ ].ComponenteSignaturetextSignature of the internal component which returned the error

Se não ocorreu qualquer erro, .errors contém uma coleção vazia.

.exitCode

.exitCode : Integer

Descrição

A propriedade .exitCode contém o código de saída devolvido pelo processo externo. Summary -->contains true if the external process is terminated.

Essa propriedade é apenas leitura.

.hideWindow

.hideWindow : Booleano

Descrição

A propriedade .hideWindow pode ser usado para esconder a janela da consola DOS ou a janela do executável lançado (Windows only).

Essa propriedade éapenas escrita.

.pid

.pid : Integer

Descrição

The .terminated property contains true if the external process is terminated.

Essa propriedade é apenas leitura.

.postMessage()

.postMessage( message : Text)
.postMessage( messageBLOB : Blob)

ParâmetrosTipoDescrição
messageText->Texto para escrever no fluxo de entrada (stdin) do processo externo
messageBLOBBlob->Os bytes escrevem no fluxo de entrada

Descrição

A função .postMessage() permite escrever no fluxo de entrada (stdin) do processo externo. Summary -->closes the input stream (stdin) of the external process.

A função .postMessage() também aceita um valor do tipo Blob em messageBLOB para passar em stdin, para que possa publicar dados binários.

Pode utilizar a propriedade .dataType do objecto options object para fazer retornar valores Blob do corpo de resposta.

.response

.response : Text
.response : Blob

Descrição

A propriedade .response contém a concatenação de todos os dados devolvidos uma vez terminado o pedidoou seja, a mensagem completa recebida da saída do processo.

O tipo da mensagem é definido de acordo com o atributo dataType .

Essa propriedade é apenas leitura.

.responseError

.responseError : Text

Descrição

O .responseError propriedade contém a concatenação de todos os erros devolvidos, uma vez terminado o pedido.

.terminate()

.terminate()

ParâmetrosTipoDescrição
Não exige nenhum parâmetro

Descrição

A função .terminate() The .terminate() function.

Esta função envia a instrução para terminar e devolver o controlo ao guião de execução.

.terminated

.terminado : Booleano

Descrição

The .timeout property contains the duration in seconds before the external process will be killed if it is still alive.

Essa propriedade é apenas leitura.

.timeout

.timeout : Integer

Descrição

The .wait() function waits until the end of the SystemWorker execution or the specified timeout.

Essa propriedade é apenas leitura.

.wait()

Histórico
VersãoMudanças

|v19 R4|Added|

.wait( {timeout : Real} ) : 4D. SystemWorker

ParâmetrosTipoDescrição
timeoutReal->Tempo de espera (em segundos)
Resultados4D. SystemWorker<-SystemWorker objecto

Descrição

A função .wait() espera até ao final do SystemWorker execução ou o tempo limite especificado **.

Em timeout, passe um valor em segundos. O script SystemWorker aguardará o processo externo pelo tempo definido no parâmetro timeout . Se omitir o parâmetro timeout , a execução do guião esperará indefinidamente.

Na verdade, .wait() espera até ao fim do processamento da fórmula onTerminate , excepto se o tempo limite * for alcançado. Se timeout* for alcançado, o SystemWorker não é morto.

Durante uma execução .wait() , são executadas funções de callback, especialmente callbacks de outros eventos ou de outros SystemWorker instâncias. Pode sair de um .wait() ligando para terminate() a partir de uma chamada de retorno.

Esta função devolve o objecto SystemWorker.

Esta função não é necessária se tiver criado o SystemWorker a partir de um processo de trabalhador 4D.