ftpfs

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _ftpfs as _ftpfs
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57RTEMS_FTPFS_CTRL_PORT = _ftpfs.RTEMS_FTPFS_CTRL_PORT
 58r"""
 59    *
 60    Well-known port number for FTP control connection.
 61    """
 62RTEMS_FTPFS_MOUNT_POINT_DEFAULT = _ftpfs.RTEMS_FTPFS_MOUNT_POINT_DEFAULT
 63r"""Default mount point for FTP file system."""
 64RTEMS_FTPFS_IOCTL_GET_VERBOSE = _ftpfs.RTEMS_FTPFS_IOCTL_GET_VERBOSE
 65
 66RTEMS_FTPFS_IOCTL_SET_VERBOSE = _ftpfs.RTEMS_FTPFS_IOCTL_SET_VERBOSE
 67
 68RTEMS_FTPFS_IOCTL_GET_TIMEOUT = _ftpfs.RTEMS_FTPFS_IOCTL_GET_TIMEOUT
 69
 70RTEMS_FTPFS_IOCTL_SET_TIMEOUT = _ftpfs.RTEMS_FTPFS_IOCTL_SET_TIMEOUT
 71
 72
 73def rtems_ftpfs_get_verbose(mount_point, verbose):
 74    r"""
 75    Returns in *verbose* if the verbose mode is enabled or disabled for
 76    the file system at *mount_point*.
 77
 78    If *mount_point* is ``NULL`` the default mount point
 79    'RTEMS_FTPFS_MOUNT_POINT_DEFAULT' will be used.
 80    """
 81    return _ftpfs.rtems_ftpfs_get_verbose(mount_point, verbose)
 82
 83def rtems_ftpfs_set_verbose(mount_point, verbose):
 84    r"""
 85    Enables or disables the verbose mode if *verbose* is ``true`` or
 86    ``false`` respectively for the file system at *mount_point*.
 87
 88    In the enabled verbose mode the commands and replies of the FTP control
 89    connections will be printed to standard error.
 90
 91    If *mount_point* is ``NULL`` the default mount point
 92    'RTEMS_FTPFS_MOUNT_POINT_DEFAULT' will be used.
 93    """
 94    return _ftpfs.rtems_ftpfs_set_verbose(mount_point, verbose)
 95
 96def rtems_ftpfs_get_timeout(mount_point, timeout):
 97    r"""
 98    Returns the current timeout value in *timeout* for the file system
 99    at *mount_point*.
100
101    If *mount_point* is ``NULL`` the default mount point
102    'RTEMS_FTPFS_MOUNT_POINT_DEFAULT' will be used.
103    """
104    return _ftpfs.rtems_ftpfs_get_timeout(mount_point, timeout)
105
106def rtems_ftpfs_set_timeout(mount_point, timeout):
107    r"""
108    Sets the timeout value to *timeout* for the file system at
109    *mount_point*.
110
111    The timeout value will be used during connection establishment of active
112    data connections.  It will be also used for send and receive operations on
113    data and control connections.
114
115    If *mount_point* is ``NULL`` the default mount point
116    'RTEMS_FTPFS_MOUNT_POINT_DEFAULT' will be used.
117    """
118    return _ftpfs.rtems_ftpfs_set_timeout(mount_point, timeout)
119
120def rtems_ftpfs_initialize(mt_entry, data):
121    r"""Do not call directly, use mount()."""
122    return _ftpfs.rtems_ftpfs_initialize(mt_entry, data)