Skip to content

Commit aaa221c

Browse files
StartAutomatingStartAutomating
authored andcommitted
UDP Protocol: Fixing help and improving validation (Fixes #282)
1 parent 281218d commit aaa221c

1 file changed

Lines changed: 75 additions & 1 deletion

File tree

docs/UDP.Protocol.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,76 @@
1-
UDP.Protocol.psx.ps1 [-CommandUri] <uri> [-CommandAst] <CommandAst> [<CommonParameters>]
1+
UDP.Protocol
2+
------------
3+
### Synopsis
4+
udp protocol
5+
6+
---
7+
### Description
8+
9+
Converts a UDP protocol command to PowerShell
10+
11+
---
12+
### Examples
13+
#### EXAMPLE 1
14+
```PowerShell
15+
udp://127.0.0.1:8568 # Creates a UDP Client
16+
```
17+
18+
#### EXAMPLE 2
19+
```PowerShell
20+
udp:// -Host [ipaddress]::broadcast -port 911 -Send "It's an emergency!"
21+
```
22+
23+
#### EXAMPLE 3
24+
```PowerShell
25+
{send udp:// -Host [ipaddress]::broadcast -Port 911 "It's an emergency!"}.Transpile()
26+
```
27+
28+
#### EXAMPLE 4
29+
```PowerShell
30+
Invoke-PipeScript { receive udp://*:911 }
31+
```
32+
Invoke-PipeScript { send udp:// -Host [ipaddress]::broadcast -Port 911 "It's an emergency!" }
33+
34+
Invoke-PipeScript { receive udp://*:911 -Keep }
35+
---
36+
### Parameters
37+
#### **CommandUri**
38+
39+
The URI.
40+
41+
42+
43+
> **Type**: ```[Uri]```
44+
45+
> **Required**: true
46+
47+
> **Position**: 1
48+
49+
> **PipelineInput**:true (ByValue)
50+
51+
52+
53+
---
54+
#### **CommandAst**
55+
56+
The Command's Abstract Syntax Tree
57+
58+
59+
60+
> **Type**: ```[CommandAst]```
61+
62+
> **Required**: true
63+
64+
> **Position**: 2
65+
66+
> **PipelineInput**:false
67+
68+
69+
70+
---
71+
### Syntax
72+
```PowerShell
73+
UDP.Protocol [-CommandUri] <Uri> [-CommandAst] <CommandAst> [<CommonParameters>]
74+
```
75+
---
276

0 commit comments

Comments
 (0)