Class: Socket

@nginstack/engine/lib/net/Socket~ Socket


new Socket(remoteHost, remotePort)

Classe que permite a comunicação de rede por meio do protocolo TCP.

Parameters:
Name Type Description
remoteHost string

Ip ou nome do servidor ao qual o socket irá conectar.

remotePort number

Porta do servidor ao qual o socket irá se conectar.

Members


connected :boolean

Determina se a conexão foi estabelecida com o servidor.

Type:
  • boolean

<readonly> localAddress :string

Endereço IP local utilizado para estabelecer a conexão.

Type:
  • string

localHost :string

Nome de rede associado ao IP local utilizado para estabelecer a conexão.

Type:
  • string

localPort :number

Porta local utilizada para estabelecer a conexão.

Type:
  • number

<readonly> remoteAddress :string

Endereço IP do servidor ao qual o socket está conectado.

Type:
  • string

<readonly> remoteHost :string

Nome do servidor ao qual o socket está conectado.

Type:
  • string

<readonly> remotePort :number

Porta do servidor ao qual o socket está conectado.

Type:
  • number

Methods


close()

Fecha a conexão.


open()

Abre a conexão.


peek(length [, timeout])

Lê uma sequência de bytes do socket, mas sem retirar esses dados do buffer de leitura do socket.

Parameters:
Name Type Argument Description
length number

Quantidade de bytes que serão lidos.

timeout number <optional>

Tempo limite em milissegundos para a leitura dos dados. Caso não seja informado, serão aguardados 60 segundos.

Returns:

Conteúdo que foi lido.

Type
string

read(length [, timeout])

Lê uma sequência de bytes do socket.

Parameters:
Name Type Argument Description
length number

Quantidade de bytes que serão lidos.

timeout number <optional>

Tempo limite em milissegundos para a leitura dos dados. Caso não seja informado, serão aguardados 60 segundos.

Returns:

Conteúdo que foi lido.

Type
string

readln( [timeout])

Lê uma sequência de bytes até encontrar uma quebra de linha.

Parameters:
Name Type Argument Description
timeout number <optional>

Tempo limite em milissegundos para a leitura dos dados. Caso não seja informado, serão aguardados 60 segundos.

Returns:

Conteúdo que foi lido.

Type
string

write(content [, timeout])

Escreve uma sequência de bytes do socket.

Parameters:
Name Type Argument Description
content string | ArrayBuffer

Conteúdo que será enviado. Valores do tipo string são transmitidos na codificação Latin-1.

timeout number <optional>

Tempo limite em milissegundos para a escrita dos dados. Caso não seja informado, serão aguardados 60 segundos.