Files
Jungfraujoch/_sources/python_client/docs/TcpSettings.md.txt
T
2026-06-25 21:18:12 +00:00

35 lines
1.9 KiB
Plaintext

# TcpSettings
TCP image stream configuration for Jungfraujoch software. This structure is used to provide default settings using configuration JSON file and is not used in HTTP.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**send_buffer_size** | **int** | Send buffer size for TCP/IP socket | [optional]
**image_socket** | **str** | tcp://<IP address>:<port> 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces | [optional]
**nwriters** | **int** | Number of TCP/IP writers to be used for streaming images | [optional] [default to 32]
**peer_liveness_timeout_ms** | **int** | Max time (in milliseconds) a send may block with no sign of life from the writer (no BUSY heartbeat or ACK) before the connection is declared dead. Optional; the built-in default is used when unset. | [optional]
**max_backpressure_timeout_ms** | **int** | Hard upper bound (in milliseconds) on backpressure: if no bytes can be sent to the writer for this long the connection is declared dead even while the writer keeps heartbeating, so a wedged writer cannot block the run or its finalization. Optional; the built-in default is used when unset. | [optional]
## Example
```python
from jfjoch_client.models.tcp_settings import TcpSettings
# TODO update the JSON string below
json = "{}"
# create an instance of TcpSettings from a JSON string
tcp_settings_instance = TcpSettings.from_json(json)
# print the JSON string representation of the object
print(TcpSettings.to_json())
# convert the object into a dict
tcp_settings_dict = tcp_settings_instance.to_dict()
# create an instance of TcpSettings from a dict
tcp_settings_from_dict = TcpSettings.from_dict(tcp_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)