docs-v2/content/flux/v0.x/stdlib/socket/from.md

2.1 KiB

title description menu weight flux/v0.x/tags
socket.from() function `socket.from()` returns data from a socket connection and outputs a stream of tables given a specified decoder.
flux_0_x_ref
name parent identifier
socket.from socket socket/from
101
inputs

socket.from() returns data from a socket connection and outputs a stream of tables given a specified decoder.

The function produces a single table for everything that it receives from the start to the end of the connection.

Function type signature
(url: string, ?decoder: string) => stream[A]

{{% caption %}}For more information, see Function type signatures.{{% /caption %}}

Parameters

url

({{< req >}}) URL to return data from.

Supported URL schemes:

  • tcp
  • unix

decoder

Decoder to use to parse returned data into a stream of tables.

Supported decoders:

  • csv
  • line

Examples

Query annotated CSV from a socket connection

import "socket"

socket.from(url: "tcp://127.0.0.1:1234", decoder: "csv")

Query line protocol from a socket connection

import "socket"

socket.from(url: "tcp://127.0.0.1:1234", decoder: "line")