Files
Jungfraujoch/docs/python_client/docs/TcpSettings.md
Filip Leonarski 64002f1e29
Some checks failed
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 11m14s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 10m43s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 11m35s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 9m20s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 10m23s
Build Packages / Generate python client (push) Successful in 39s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 11m24s
Build Packages / Create release (push) Has been skipped
Build Packages / Build documentation (push) Successful in 1m0s
Build Packages / build:rpm (rocky8) (push) Successful in 10m35s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 10m35s
Build Packages / build:rpm (rocky9) (push) Successful in 11m17s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 9m9s
Build Packages / Unit tests (push) Failing after 1h18m57s
v1.0.0-rc.129 (#36)
This is an UNSTABLE release. The release has significant modifications and bug fixes, if things go wrong, it is better to revert to 1.0.0-rc.124.

* jfjoch_broker: Significant improvements in TCP image socket, as a viable alternative for ZeroMQ sockets (only a single port on broker side, dynamically change number of writers, acknowledgments for written files)
* jfjoch_broker: Delta phi is calculated also for still data in Bragg prediction
* jfjoch_broker: Image pusher statistics are accessible via the REST interface
* jfjoch_writer: Supports TCP image socket and for these auto-forking option

Reviewed-on: #36
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
Co-committed-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-03-05 22:13:12 +01:00

33 lines
1.3 KiB
Markdown

# 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://&lt;IP address&gt;:&lt;port&gt; 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]
## 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)