CBFS Connect 2020 Python Edition

Questions / Feedback?

on_set_allocation_size Event

Fires when the OS needs to set a file's allocation size.


class CBFSSetAllocationSizeEventParams(object):
  def file_name() -> str: ...
  def allocation_size() -> int: ...
  def handle_info() -> int: ...
  def file_context() -> int: ...
  def file_context(value) -> None: ...
  def handle_context() -> int: ...
  def handle_context(value) -> None: ...
  def result_code() -> int: ...
  def result_code(value) -> None: ...

# In class CBFS:
def on_set_allocation_size() -> Callable[[CBFSSetAllocationSizeEventParams], None]: ...
def on_set_allocation_size(event_hook: Callable[[CBFSSetAllocationSizeEventParams], None]) -> None: ...


This event fires when the OS (or the class, if the CorrectAllocationSizes configuration setting is enabled) needs to set the allocation size of the file specified by FileName. All files have three sizes associated with them:

Description Associated Event
File size The length, in bytes, of the file's contents. on_set_file_size
Allocation size The number of bytes allocated locally for the file. on_set_allocation_size
Valid data length The number of bytes that have been written to the file. on_set_valid_data_length

To handle this event properly, applications must perform any actions needed to allocate the specified amount of space for the file in their backend storage. Please note that the file's actual size should not be changed; applications that do not track allocation size separately from file size should do nothing.

The AllocationSize parameter specifies the new allocation size of the file, in bytes. This value is typically larger than the file's actual size, as some file operations reserve space for the file before any data is actually written. Applications should track such situations and avoid re-allocating file space when possible to improve performance.

The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: get_handle_creator_process_id, get_handle_creator_process_name, get_handle_creator_thread_id, or get_handle_creator_token. (This parameter may be absent, in which case it will be 0.)

The FileContext and HandleContext parameters are placeholders for application-defined data associated with the file and specific handle, respectively. Please refer to the Contexts topic for more information. (HandleContext may be absent, in which case it will be None.)

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Connect 2020 Python Edition - Version 20.0 [Build 7880]