Skip to content

file_system_device_manager_base

messageflux.iodevices.file_system.file_system_device_manager_base

FileSystemDeviceManagerBase

FileSystemDeviceManagerBase(
    root_folder,
    queue_dir_name=DEFAULT_QUEUES_SUB_DIR,
    tmp_dir_name=DEFAULT_TMPDIR_SUB_DIR,
    bookkeeping_dir_name=DEFAULT_BOOKKEEPING_SUB_DIR,
    serializer=None,
    **kwargs
)

this manager is used to create IO Devices over a shared file system

Parameters:

Name Type Description Default
root_folder str

the root folder to use for the manager

required
queue_dir_name str

the name of the subdirectory under root_folder that holds the queues

DEFAULT_QUEUES_SUB_DIR
tmp_dir_name str

the name of the subdirectory under root_folder to use for temp files

DEFAULT_TMPDIR_SUB_DIR
bookkeeping_dir_name str

the name of the subdirectory under root_folder that holds the book-keeping data

DEFAULT_BOOKKEEPING_SUB_DIR
serializer Optional[FileSystemSerializerBase]

the serializer to use to write messages to files. None will use the default serializer

None

bookkeeping_folder property

bookkeeping_folder

the full path for the book keeping folder

queues_folder property

queues_folder

the full path for the queues folder

tmp_folder property

tmp_folder

the full path for the temp folder

unique_manager_id property

unique_manager_id

this is a unique id for this manager instance

get_available_device_names

get_available_device_names()

returns a list of available 'queues' in the queue folder