Skip to Content

Endpoints

TCP connections to addresses on the host's own networks, which only rookery serve opens, for a resource's endpoint.

OperationKindHTTP
endpoints.connectstreamGET /v1/endpoints/{address}/{port}

endpoints.connect

For rookery serve alone: a TCP connection to an address on a network of the host's own interfaces, such as a container on a bridge. The address is resolved once, every address it has is checked, and the one checked is dialled first, so one that nothing answers on is an error and not a stream.

Host level only. A stream, as a subscription on the portal or a WebSocket of its own. It does not resume. Not on the portal, because rookery serve dials it itself, only for an endpoint a provisioner reported: open the endpoint with resources.connect. Through rookery serve it needs the role operate.

Arguments

NameWhereRequiredDescription
addresspathyesAn IP address or a DNS name, on a network of the host's own interfaces.
portpathyesA TCP port: a number from 1 to 65535.

Frames from the server

FrameKindDescription
bytesbinaryWhat the endpoint sent.
eofJSONThe endpoint closed its side. Bytes sent towards it still arrive. The stream ends once both sides have sent this. Example: {"eof":true}

Frames to the server

FrameKindDescription
bytesbinaryBytes for the endpoint.
eofJSONThe client sends no more, and the endpoint reads the end. What it sends still comes back. Example: {"eof":true}

Not on the portal: rookery serve dials it itself, only for an endpoint a provisioner reported: open the endpoint with resources.connect.

On this page