@@ -14,7 +14,7 @@ allowing runtime customization of network settings through environment variables
1414| ` MULTICAST_GROUPS ` | - | Space-separated list of additional multicast addresses |
1515| ` MULTICAST_TTL ` | 1 | Time-to-live value (1-126) |
1616| ` MULTICAST_BIND_ADDR ` | "0.0.0.0" | Address to bind to |
17- | ` MULTICAST_BUFFER_SIZE ` | 1024 | Receive buffer size in bytes |
17+ | ` MULTICAST_BUFFER_SIZE ` | 1316 | Receive buffer size in bytes |
1818
1919## Usage
2020
@@ -34,7 +34,7 @@ os.environ['MULTICAST_GROUP'] = '224.0.0.2'
3434# os.environ['MULTICAST_TTL'] = '2' # May harm your own bandwidth when increasing
3535# os.environ['MULTICAST_BUFFER_SIZE'] = '2048' # Expect increased data loss when increasing
3636
37- # Load configuration Loads on Import
37+ # Configuration loads on import
3838import multicast
3939```
4040
@@ -43,27 +43,27 @@ import multicast
4343``` python
4444# Join multiple multicast groups
4545os.environ[' MULTICAST_GROUPS' ] = ' 224.0.0.1 224.0.0.2 224.0.0.3'
46- # Load configuration Loads on Import
46+ # Configuration loads on import
4747import multicast
4848
4949# load config
5050from multicast.env import load_config
5151config = load_config()
5252
53- # you can now access configuration
53+ # you can now access the configuration
5454# e.g.
5555print (config[' groups' ]) # ['224.0.0.1', '224.0.0.2', '224.0.0.3']
5656```
5757
58- _ (changing the resulting config values only causes the setting to loose its special value,
58+ _ (changing the resulting config values only causes the setting to lose its special value,
5959and does not actually update Multicast after import)_
6060
6161## Configuration Details
6262
6363### Port Configuration
6464
6565- Valid range: 49152-65535 (dynamic/private ports)
66- - Invalid values trigger warning and fall back to default
66+ - Invalid values trigger a warning and fall back to default
6767- Example:
6868
6969 ``` python
@@ -73,7 +73,7 @@ and does not actually update Multicast after import)_
7373### Group Configuration
7474
7575- Must be valid multicast addresses (224.0.0.0/4)
76- - Invalid addresses trigger warning and fall back to default
76+ - Invalid addresses trigger a warning and fall back to default
7777- Example:
7878
7979 ``` python
@@ -93,7 +93,7 @@ and does not actually update Multicast after import)_
9393### Buffer Size Configuration
9494
9595- Must be positive integer
96- - Invalid values trigger warning and fall back to default
96+ - Invalid values trigger a warning and fall back to default
9797- Example:
9898
9999 ``` python
@@ -103,7 +103,7 @@ and does not actually update Multicast after import)_
103103## Caveat
104104
105105- Environment variables must be set before importing the module
106- - Invalid values trigger warnings but won't cause failures
106+ - Invalid values trigger a warnings but won't cause failures
107107- Changes to configuration affect all subsequent operations
108108
109109## References
0 commit comments