# router

`jumpstarter.v1`

## Services

### RouterService

Router service for multiplexing bidirectional streams between clients and exporters. Claims: iss: jumpstarter controller aud: jumpstarter router sub: jumpstarter client/exporter stream: stream id.

| Method | Request | Response | Description |
| --- | --- | --- | --- |
| `Stream` | stream [`StreamRequest`](router.md#streamrequest) | stream [`StreamResponse`](router.md#streamresponse) | Stream connects caller to another caller of the same stream. |

## Messages

### StreamRequest

Request message for bidirectional stream communication.

| Field | Number | Type | Label | Description |
| --- | --- | --- | --- | --- |
| `payload` | 1 | `bytes` |  | The raw bytes of the stream frame. |
| `frame_type` | 2 | [`FrameType`](router.md#frametype) |  | The type of frame being sent. |

### StreamResponse

Response message for bidirectional stream communication.

| Field | Number | Type | Label | Description |
| --- | --- | --- | --- | --- |
| `payload` | 1 | `bytes` |  | The raw bytes of the stream frame. |
| `frame_type` | 2 | [`FrameType`](router.md#frametype) |  | The type of frame being received. |

## Enums

### FrameType

Frame types for the stream protocol.

| Name | Number | Description |
| --- | --- | --- |
| `FRAME_TYPE_DATA` | 0 | Data frame carrying payload bytes. |
| `FRAME_TYPE_RST_STREAM` | 3 | Reset stream signal. |
| `FRAME_TYPE_PING` | 6 | Keepalive ping frame. |
| `FRAME_TYPE_GOAWAY` | 7 | Graceful shutdown signal. |