IPWorks SSH 2020 Python Edition

Questions / Feedback?

client_record_length Property

If set to a positive value, this setting defines the length of data records to be received.

Syntax

def get_client_record_length(client_id: int) -> int: ...
def set_client_record_length(client_id: int, value: int) -> None: ...

Default Value

0

Remarks

If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the on_data_in event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the on_data_in event.

A value of 0 (default) means this setting is not used.

The client_id parameter specifies the index of the item in the array. The size of the array is controlled by the client_count property.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Python Edition - Version 20.0 [Build 8501]