OpenAPI: Add TCP socket pusher settings + add monitoring of images written with OpenAPI
This commit is contained in:
@@ -216,6 +216,7 @@ Class | Method | HTTP request | Description
|
||||
- [ScanResultImagesInner](docs/ScanResultImagesInner.md)
|
||||
- [SpotFindingSettings](docs/SpotFindingSettings.md)
|
||||
- [StandardDetectorGeometry](docs/StandardDetectorGeometry.md)
|
||||
- [TcpSettings](docs/TcpSettings.md)
|
||||
- [UnitCell](docs/UnitCell.md)
|
||||
- [ZeromqMetadataSettings](docs/ZeromqMetadataSettings.md)
|
||||
- [ZeromqPreviewSettings](docs/ZeromqPreviewSettings.md)
|
||||
|
||||
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pcie** | [**List[PcieDevicesInner]**](PcieDevicesInner.md) | | [optional]
|
||||
**zeromq** | [**ZeromqSettings**](ZeromqSettings.md) | | [optional]
|
||||
**tcp** | [**TcpSettings**](TcpSettings.md) | | [optional]
|
||||
**instrument** | [**InstrumentMetadata**](InstrumentMetadata.md) | | [optional]
|
||||
**file_writer** | [**FileWriterSettings**](FileWriterSettings.md) | | [optional]
|
||||
**detector** | [**List[Detector]**](Detector.md) | |
|
||||
|
||||
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
||||
**images_expected** | **int** | | [optional]
|
||||
**images_collected** | **int** | Images collected by the receiver. This number will be lower than images expected if there were issues with data collection performance. | [optional]
|
||||
**images_sent** | **int** | Images sent to the writer. The value does not include images discarded by lossy compression filter and images not forwarded due to full ZeroMQ queue. | [optional]
|
||||
**images_written** | **int** | Images successfully written to disk. The value is live updated for TCP/IP socket and direct HDF5 writer, while for ZeroMQ it is only updated at the end of experiment. | [optional]
|
||||
**images_discarded_lossy_compression** | **int** | Images discarded by the lossy compression filter | [optional]
|
||||
**max_image_number_sent** | **int** | | [optional]
|
||||
**collection_efficiency** | **float** | | [optional]
|
||||
|
||||
32
docs/python_client/docs/TcpSettings.md
Normal file
32
docs/python_client/docs/TcpSettings.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# 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]
|
||||
**addr** | **str** | tcp://<IP address>:<port> 0.0.0.0 instead of IP address is accepted and means listening on all network interfaces |
|
||||
**nwriters** | **int** | Number of TCP/IP writers to be used for streaming images | [optional] [default to 1]
|
||||
|
||||
## 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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user