Class: Engine

@nginstack/engine/lib/engine/Engine~ Engine


new Engine()

Representa o Engine em execução. Tem a finalidade de agrupar os componentes globais e comuns a todos os ambientes JavaScript.

Esta classe não possui construtor, estando disponível apenas através da variável global "engine".

Members


applicationFileName :string

Nome do arquivo executável do Servidor Engine.

Type:
  • string

applicationPath :string

Diretório onde são armazenados os arquivos de dados permanentes do Engine. Nos cenários mais comuns, equivale ao diretório onde o Engine está instalado, mas isso não é obrigatório em cenários de uso mais avançadas. O caminho retornado é terminado por um caractere separador de Paths.

Type:
  • string
Deprecated:
  • Utilize #dataDir ou #programDir.

arch :string

Nome de identificação da arquitetura alvo de processador do executável. Possíveis valores são 'x32' e 'x64'.

Type:
  • string

dataDir :string

Diretório onde são armazenados os arquivos de dados permanentes do Engine. Ele é definido por meio do parâmetro de comando de linha passado na inicialização do Engine --appdatadir ou da variável de ambiente NGIN_APP_DATA_DIR. Se não for informado, é usado o diretório onde o Engine está instalado. Também ele será o diretório corrente do Engine.

Type:
  • string

instanceId :string

Id que identifica de forma única o servidor Engine que está executando este script.

Type:
  • string

keyCacheRange :number

Informa o tamanho dos blocos de chaves reservados. O Engine mantém localmente uma reserva de chaves novas para serem usadas na criação de novos registros. Quando essa reserva fica menor do que o valor de keyCacheRange, o Engine aloca no Servidor da Base um novo bloco de chaves

Type:
  • number

localAddress :string

Endereço IP do Servidor Engine.

Type:
  • string

localHost :string

Nome de Rede do Servidor Engine.

Type:
  • string

localPort


logDir :string

Diretório onde são armazenados os arquivos de logs do Engine. Ele é definido por meio do parâmetro de comando de linha passado na inicialização do Engine --applogdir ou da variável de ambiente NGIN_APP_LOG_DIR. Se não for informado, é usado o subdiretório logs do diretório definido em #dataDir.

Type:
  • string

platform :string

Nome de identificação da plataforma. Possíveis valores são 'win32' e 'linux'.

Type:
  • string

processId :number

Identificador do processo do servidor engine em execução.

Type:
  • number

programDir :string

Diretório onde estão instalados o Engine, suas bibliotecas e executáveis complementares. Observe que em alguns cenários de uso, ela pode ser diferente de #dataDir.

Type:
  • string

progressMonitor :ProgressMonitor

Monitor do progresso das tarefas em execução dos threads ativos.

Type:
See:

sessionManager :SessionManager

Gerenciador de sessões JavaScript do Engine.

Type:
See:

startTime :Date

Data/Hora que o Servidor Engine iniciou.

Type:
  • Date

tmpDir :string

Diretório onde são armazenados os arquivos temporários do Engine. Ele é definido por meio do parâmetro de comando de linha passado na inicialização do Engine --apptmpdir ou da variável de ambiente NGIN_APP_TMP_DIR. Se não for informado, é usado o subdiretório tmp do diretório definido em #dataDir.

Type:
  • string

version :string

O número da versão do servidor Engine.

Type:
  • string

versionInfo :VersionInfo

Propriedades da versão definidas no resource do executável.

Type:
  • VersionInfo

Methods


exit( [exitCode] [, delay])

Encerra o Engine após o delay informado em segundos.

Parameters:
Name Type Argument Description
exitCode number <optional>

Código de saída do Engine para o sistema operacional.

delay number <optional>

Atraso em milissegundos solicitar o encerramento do Engine. Caso não seja informado, será finalizado imediatamente.


getPorts()

Retorna um array de objetos com as portas disponíveis no engine, onde, cada objeto informa a porta, endereço e o protocolo usado. As propriedades do objeto são: "port" que retorna a porta, address que retorna o endereço associado a porta e "protocol" que retorna o protocolo daquela porta.

Returns:
Type
Array.<Object>
Example
var ports = server.getPorts();
 if (ports.length > 0) {
   return ar[0].port + ' ' + ar[0].protocol + ' ' + ar[0].address
 }

osRun(command, opt_wait, opt_commandShow)

Cria um novo processo do S.O., executando o aplicativo

Parameters:
Name Type Description
command string

Comando a ser executado

opt_wait boolean

Se "true", a função retorna apenas depois que o processo termina a sua execução.

opt_commandShow string

Indica a forma como a janela do processo criado deve ser exibida. Os valores possíveis são HIDE, SHOW, MINIMIZE e MAXIMIZE

Deprecated:
Returns:

Se wait = true, retorna o código de retorno do processo. Caso contrário, retorna 0 se falhou e diferente de 0 se foi sucesso.

Type
number

restart( [delay])

Solicita o reinício do Engine após o delay informado em segundos.

Parameters:
Name Type Argument Description
delay number <optional>

Atraso em milissegundos para reiniciar o Engine. Caso não seja informado, será solicitado o reinício imediato.


setKioskMode(kioskMode)

Configura o engine para chamar o browser em modo kiosk. Por padrão ele está desabilitado.

Parameters:
Name Type Description
kioskMode boolean

Se true habilita o modo kiosk.