Skip to content

Commit a3e1619

Browse files
committed
added timeout flag to TCP messages in docs
Signed-off-by: bota <[email protected]>
1 parent 5c99c04 commit a3e1619

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/book/v1/commands.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ To run the commands via CLI, use the following syntax:
1919

2020
To use commands using TCP messages the following messages can be used:
2121

22-
`echo "failed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat - TCP:host:port`
22+
`echo "failed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat -t1 - TCP:host:port`
2323

24-
`echo "processed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat - TCP:host:port`
24+
`echo "processed --start=yyyy-mm-dd --end=yyyy-mm-dd --limit=days" | socat -t1 - TCP:host:port`
2525

2626
In both cases the flags are optional. Keep in mind if both `start` and `end` are set, `limit` will not be applied, it's only used when one of `start` or `end` is missing.
2727

2828
In order to be able to test the `processed` command, by default when processing the "control" message, it is logged as successfully processed with `"levelName":"info"` simulating that the message was processed successfully. To use it run the following message:
2929

30-
`echo "control" | socat - TCP:host:port`
30+
`echo "control" | socat -t1 - TCP:host:port`

0 commit comments

Comments
 (0)