docs/network: Move confusingly-named cc3200 Server class to its reference.
cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
This commit is contained in:
parent
22ca5390f7
commit
92206a78ae
@ -29,52 +29,6 @@ For example::
|
|||||||
data = s.recv(1000)
|
data = s.recv(1000)
|
||||||
s.close()
|
s.close()
|
||||||
|
|
||||||
.. only:: port_wipy
|
|
||||||
|
|
||||||
.. _network.Server:
|
|
||||||
|
|
||||||
class Server
|
|
||||||
============
|
|
||||||
|
|
||||||
The ``Server`` class controls the behaviour and the configuration of the FTP and telnet
|
|
||||||
services running on the WiPy. Any changes performed using this class' methods will
|
|
||||||
affect both.
|
|
||||||
|
|
||||||
Example::
|
|
||||||
|
|
||||||
import network
|
|
||||||
server = network.Server()
|
|
||||||
server.deinit() # disable the server
|
|
||||||
# enable the server again with new settings
|
|
||||||
server.init(login=('user', 'password'), timeout=600)
|
|
||||||
|
|
||||||
Constructors
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. class:: network.Server(id, ...)
|
|
||||||
|
|
||||||
Create a server instance, see ``init`` for parameters of initialization.
|
|
||||||
|
|
||||||
Methods
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. method:: server.init(\*, login=('micro', 'python'), timeout=300)
|
|
||||||
|
|
||||||
Init (and effectively start the server). Optionally a new ``user``, ``password``
|
|
||||||
and ``timeout`` (in seconds) can be passed.
|
|
||||||
|
|
||||||
.. method:: server.deinit()
|
|
||||||
|
|
||||||
Stop the server
|
|
||||||
|
|
||||||
.. method:: server.timeout([timeout_in_seconds])
|
|
||||||
|
|
||||||
Get or set the server timeout.
|
|
||||||
|
|
||||||
.. method:: server.isrunning()
|
|
||||||
|
|
||||||
Returns ``True`` if the server is running, ``False`` otherwise.
|
|
||||||
|
|
||||||
.. only:: port_pyboard
|
.. only:: port_pyboard
|
||||||
|
|
||||||
class CC3K
|
class CC3K
|
||||||
|
@ -323,3 +323,40 @@ Unrelated function in machine module
|
|||||||
this function is not called then the default file main.py will be executed.
|
this function is not called then the default file main.py will be executed.
|
||||||
|
|
||||||
It only makes sense to call this function from within boot.py.
|
It only makes sense to call this function from within boot.py.
|
||||||
|
|
||||||
|
Adhoc way to control telnet/FTP server via network module
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
The ``Server`` class controls the behaviour and the configuration of the FTP and telnet
|
||||||
|
services running on the WiPy. Any changes performed using this class' methods will
|
||||||
|
affect both.
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
|
import network
|
||||||
|
server = network.Server()
|
||||||
|
server.deinit() # disable the server
|
||||||
|
# enable the server again with new settings
|
||||||
|
server.init(login=('user', 'password'), timeout=600)
|
||||||
|
|
||||||
|
.. class:: network.Server(id, ...)
|
||||||
|
|
||||||
|
Create a server instance, see ``init`` for parameters of initialization.
|
||||||
|
|
||||||
|
.. method:: server.init(\*, login=('micro', 'python'), timeout=300)
|
||||||
|
|
||||||
|
Init (and effectively start the server). Optionally a new ``user``, ``password``
|
||||||
|
and ``timeout`` (in seconds) can be passed.
|
||||||
|
|
||||||
|
.. method:: server.deinit()
|
||||||
|
|
||||||
|
Stop the server
|
||||||
|
|
||||||
|
.. method:: server.timeout([timeout_in_seconds])
|
||||||
|
|
||||||
|
Get or set the server timeout.
|
||||||
|
|
||||||
|
.. method:: server.isrunning()
|
||||||
|
|
||||||
|
Returns ``True`` if the server is running, ``False`` otherwise.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user