telnetd

  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 _telnetd as _telnetd
  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
 57
 58def rtems_telnetd_login_check(user, passphrase):
 59    r"""
 60    rtems_telnetd_login_check(char const * user, char const * passphrase) -> bool
 61
 62    Parameters
 63    ----------
 64    user: char const *
 65    passphrase: char const *
 66
 67    """
 68    return _telnetd.rtems_telnetd_login_check(user, passphrase)
 69class rtems_telnetd_config_table(object):
 70    r"""Telnet configuration structure."""
 71
 72    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 73    __repr__ = _swig_repr
 74    command = property(_telnetd.rtems_telnetd_config_table_command_get, _telnetd.rtems_telnetd_config_table_command_set, doc=r"""
 75    Function invoked for each Telnet connection.
 76
 77    The first parameter contains the device name.  The second parameter
 78    contains the argument pointer of this configuration table.
 79    """)
 80    arg = property(_telnetd.rtems_telnetd_config_table_arg_get, _telnetd.rtems_telnetd_config_table_arg_set, doc=r"""Argument for command function.""")
 81    priority = property(_telnetd.rtems_telnetd_config_table_priority_get, _telnetd.rtems_telnetd_config_table_priority_set, doc=r"""
 82    Task priority.
 83
 84    Use 0 for the default value.
 85    """)
 86    stack_size = property(_telnetd.rtems_telnetd_config_table_stack_size_get, _telnetd.rtems_telnetd_config_table_stack_size_set, doc=r"""
 87    Task stack size.
 88
 89    Use 0 for the default value.
 90    """)
 91    login_check = property(_telnetd.rtems_telnetd_config_table_login_check_get, _telnetd.rtems_telnetd_config_table_login_check_set, doc=r"""
 92    Login check function.
 93
 94    Method used for login checks.  Use ``NULL`` to disable a login check.
 95    """)
 96    keep_stdio = property(_telnetd.rtems_telnetd_config_table_keep_stdio_get, _telnetd.rtems_telnetd_config_table_keep_stdio_set, doc=r"""
 97    This is an obsolete configuration option.
 98
 99    It must be set to false, otherwise rtems_telnetd_start() will do nothing
100    and returns with a status of RTEMS_NOT_IMPLEMENTED.
101    """)
102    client_maximum = property(_telnetd.rtems_telnetd_config_table_client_maximum_get, _telnetd.rtems_telnetd_config_table_client_maximum_set, doc=r"""
103    Maximum number of clients which can connect to the system at a
104    time.
105
106    Use 0 for the default value.
107    """)
108    port = property(_telnetd.rtems_telnetd_config_table_port_get, _telnetd.rtems_telnetd_config_table_port_set, doc=r"""
109    Server port number in host byte order.
110
111    Use 0 for the default value.
112    """)
113
114    def __init__(self):
115        r"""__init__(rtems_telnetd_config_table self) -> rtems_telnetd_config_table"""
116        _telnetd.rtems_telnetd_config_table_swiginit(self, _telnetd.new_rtems_telnetd_config_table())
117    __swig_destroy__ = _telnetd.delete_rtems_telnetd_config_table
118
119# Register rtems_telnetd_config_table in _telnetd:
120_telnetd.rtems_telnetd_config_table_swigregister(rtems_telnetd_config_table)
121
122def rtems_telnetd_start(config):
123    r"""Starts the Telnet server using the provided configuration."""
124    return _telnetd.rtems_telnetd_start(config)
125
126def rtems_telnetd_initialize():
127    r"""
128    Initializes the Telnet subsystem.
129
130    Uses the application provided 'rtems_telnetd_config' configuration table.
131    """
132    return _telnetd.rtems_telnetd_initialize()
133
134cvar = _telnetd.cvar
def rtems_telnetd_login_check(user, passphrase):
59def rtems_telnetd_login_check(user, passphrase):
60    r"""
61    rtems_telnetd_login_check(char const * user, char const * passphrase) -> bool
62
63    Parameters
64    ----------
65    user: char const *
66    passphrase: char const *
67
68    """
69    return _telnetd.rtems_telnetd_login_check(user, passphrase)

rtems_telnetd_login_check(char const * user, char const * passphrase) -> bool

Parameters

user: char const * passphrase: char const *

class rtems_telnetd_config_table:
 70class rtems_telnetd_config_table(object):
 71    r"""Telnet configuration structure."""
 72
 73    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 74    __repr__ = _swig_repr
 75    command = property(_telnetd.rtems_telnetd_config_table_command_get, _telnetd.rtems_telnetd_config_table_command_set, doc=r"""
 76    Function invoked for each Telnet connection.
 77
 78    The first parameter contains the device name.  The second parameter
 79    contains the argument pointer of this configuration table.
 80    """)
 81    arg = property(_telnetd.rtems_telnetd_config_table_arg_get, _telnetd.rtems_telnetd_config_table_arg_set, doc=r"""Argument for command function.""")
 82    priority = property(_telnetd.rtems_telnetd_config_table_priority_get, _telnetd.rtems_telnetd_config_table_priority_set, doc=r"""
 83    Task priority.
 84
 85    Use 0 for the default value.
 86    """)
 87    stack_size = property(_telnetd.rtems_telnetd_config_table_stack_size_get, _telnetd.rtems_telnetd_config_table_stack_size_set, doc=r"""
 88    Task stack size.
 89
 90    Use 0 for the default value.
 91    """)
 92    login_check = property(_telnetd.rtems_telnetd_config_table_login_check_get, _telnetd.rtems_telnetd_config_table_login_check_set, doc=r"""
 93    Login check function.
 94
 95    Method used for login checks.  Use ``NULL`` to disable a login check.
 96    """)
 97    keep_stdio = property(_telnetd.rtems_telnetd_config_table_keep_stdio_get, _telnetd.rtems_telnetd_config_table_keep_stdio_set, doc=r"""
 98    This is an obsolete configuration option.
 99
100    It must be set to false, otherwise rtems_telnetd_start() will do nothing
101    and returns with a status of RTEMS_NOT_IMPLEMENTED.
102    """)
103    client_maximum = property(_telnetd.rtems_telnetd_config_table_client_maximum_get, _telnetd.rtems_telnetd_config_table_client_maximum_set, doc=r"""
104    Maximum number of clients which can connect to the system at a
105    time.
106
107    Use 0 for the default value.
108    """)
109    port = property(_telnetd.rtems_telnetd_config_table_port_get, _telnetd.rtems_telnetd_config_table_port_set, doc=r"""
110    Server port number in host byte order.
111
112    Use 0 for the default value.
113    """)
114
115    def __init__(self):
116        r"""__init__(rtems_telnetd_config_table self) -> rtems_telnetd_config_table"""
117        _telnetd.rtems_telnetd_config_table_swiginit(self, _telnetd.new_rtems_telnetd_config_table())
118    __swig_destroy__ = _telnetd.delete_rtems_telnetd_config_table

Telnet configuration structure.

rtems_telnetd_config_table()
115    def __init__(self):
116        r"""__init__(rtems_telnetd_config_table self) -> rtems_telnetd_config_table"""
117        _telnetd.rtems_telnetd_config_table_swiginit(self, _telnetd.new_rtems_telnetd_config_table())

__init__(rtems_telnetd_config_table self) -> rtems_telnetd_config_table

thisown
73    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

The membership flag

command
arg
priority
stack_size
login_check
keep_stdio
client_maximum
port
def rtems_telnetd_start(config):
123def rtems_telnetd_start(config):
124    r"""Starts the Telnet server using the provided configuration."""
125    return _telnetd.rtems_telnetd_start(config)

Starts the Telnet server using the provided configuration.

def rtems_telnetd_initialize():
127def rtems_telnetd_initialize():
128    r"""
129    Initializes the Telnet subsystem.
130
131    Uses the application provided 'rtems_telnetd_config' configuration table.
132    """
133    return _telnetd.rtems_telnetd_initialize()

Initializes the Telnet subsystem.

Uses the application provided 'rtems_telnetd_config' configuration table.

cvar = See C documentation