# PortRelayService

> The PortRelayService methods and their request and response messages.

Source: https://engramsfactory.com/docs/api/port-relay/

Generated from [`session.proto`](https://github.com/cortexapps/engrams/blob/main/crates/engram-protocol/proto/engram/app/v1/session.proto). Every method is
`POST /rpc/engram.app.v1.PortRelayService/<Method>` with a JSON or protobuf body and an
`x-api-key` header.

## Methods

| Method | Request | Response |
|---|---|---|
| `Relay` | [`RelayPortRequest`](#relayportrequest) (stream) | [`RelayPortResponse`](#relayportresponse) (stream) |

## Messages

### PortClose

No fields.

### PortOpen

| Field | Type |
|---|---|
| `session_id` | `string` |
| `port` | `uint32` |

### RelayPortRequest

| Field | Type |
|---|---|
| `open` | [`PortOpen`](#portopen) (one of frame) |
| `data` | `bytes` (one of frame) |
| `close` | [`PortClose`](#portclose) (one of frame) |

### RelayPortResponse

| Field | Type |
|---|---|
| `data` | `bytes` (one of frame) |
| `close` | [`PortClose`](#portclose) (one of frame) |
