resynth 0.5.0

A packet synthesis language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

 # VXLAN Encapsulation

 Encapsulates ethernet frames in [UDP](../ipv4/udp/README.md) datagrams.
## Index


### Classes

| Class | Description |
| ----- | ----------- |
| [Vxlan](Vxlan.md) | VXLAN Session |

### Functions

| Function | Returns | Description |
| -------- | ------- | ----------- |
| [session](#session) | [Vxlan](../vxlan/Vxlan.md) | Create a VXLAN session |

### Constants

| Name | Value |
| ---- | ----- |
| DEFAULT_PORT | `(u16)0x12b5` |



## session
```resynth
resynth fn session (
    cl: Sock4,
    sv: Sock4,
    sessionid: u32 = 0x00000000,
    raw: bool = false,
) -> Vxlan;
```
Create a VXLAN session

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `cl` | `Sock4` | Client (sender) socket address |
| `sv` | `Sock4` | Server (receiver) socket address |
| `sessionid` | `u32` | VXLAN Network Identifier (VNI) _(default: `0x00000000`)_ |
| `raw` | `bool` | Enable raw mode; disables automatic IP/UDP header computation _(default: `false`)_ |

### Returns

| Type |
| ---- |
| [Vxlan](../vxlan/Vxlan.md) |