summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanicampora <daniel@wipy.io>2016-02-22 22:51:22 +0100
committerdanicampora <daniel@wipy.io>2016-02-22 22:54:34 +0100
commitadd930c4b5baa029d454f78c6c6a14093b1d902f (patch)
tree8a54979fb69d88ec1fcfaf2670f403567e2bc8ae
parent12547ce737741bab006900c8e325b86c955e057e (diff)
cc3200: Rename 'server' class to 'Server' for consistency.
-rw-r--r--cc3200/mods/modnetwork.c4
-rw-r--r--cc3200/qstrdefsport.h2
-rw-r--r--docs/library/network.rst14
-rw-r--r--docs/wipy/quickref.rst6
-rw-r--r--tests/wipy/wlan/server.py2
5 files changed, 14 insertions, 14 deletions
diff --git a/cc3200/mods/modnetwork.c b/cc3200/mods/modnetwork.c
index 44d316901..5891f718b 100644
--- a/cc3200/mods/modnetwork.c
+++ b/cc3200/mods/modnetwork.c
@@ -153,7 +153,7 @@ STATIC const mp_map_elem_t mp_module_network_globals_table[] = {
{ MP_OBJ_NEW_QSTR(MP_QSTR_WLAN), (mp_obj_t)&mod_network_nic_type_wlan },
#if (MICROPY_PORT_HAS_TELNET || MICROPY_PORT_HAS_FTP)
- { MP_OBJ_NEW_QSTR(MP_QSTR_server), (mp_obj_t)&network_server_type },
+ { MP_OBJ_NEW_QSTR(MP_QSTR_Server), (mp_obj_t)&network_server_type },
#endif
};
@@ -177,7 +177,7 @@ STATIC MP_DEFINE_CONST_DICT(network_server_locals_dict, network_server_locals_di
STATIC const mp_obj_type_t network_server_type = {
{ &mp_type_type },
- .name = MP_QSTR_server,
+ .name = MP_QSTR_Server,
.make_new = network_server_make_new,
.locals_dict = (mp_obj_t)&network_server_locals_dict,
};
diff --git a/cc3200/qstrdefsport.h b/cc3200/qstrdefsport.h
index 2bd7daa11..34fdcda58 100644
--- a/cc3200/qstrdefsport.h
+++ b/cc3200/qstrdefsport.h
@@ -279,7 +279,7 @@ Q(CERT_REQUIRED)
// for network class
Q(network)
-Q(server)
+Q(Server)
Q(init)
Q(deinit)
Q(login)
diff --git a/docs/library/network.rst b/docs/library/network.rst
index 11e7a2a41..6b72ad2c6 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -30,27 +30,27 @@ For example::
.. only:: port_wipy
- .. _network.server:
+ .. _network.Server:
- class server
+ class Server
============
- The server class controls the behaviour and the configuration of the FTP and telnet
+ 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
- s = network.server()
- s.deinit() # disable the server
+ server = network.Server()
+ server.deinit() # disable the server
# enable the server again with new settings
- s.init(login=('user', 'password'), timeout=600)
+ server.init(login=('user', 'password'), timeout=600)
Constructors
------------
- .. class:: network.server(id, ...)
+ .. class:: network.Server(id, ...)
Create a server instance, see ``init`` for parameters of initialization.
diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst
index 6c2cf0de7..a2886e78c 100644
--- a/docs/wipy/quickref.rst
+++ b/docs/wipy/quickref.rst
@@ -201,12 +201,12 @@ See :ref:`network.WLAN <network.WLAN>` and :mod:`machine`. ::
Telnet and FTP server
---------------------
-See :ref:`network.server <network.server>` ::
+See :ref:`network.Server <network.Server>` ::
- from network import server
+ from network import Server
# init with new user, password and seconds timeout
- server = server.init(login=('user', 'password'), timeout=60)
+ server = Server(login=('user', 'password'), timeout=60)
server.timeout(300) # change the timeout
server.timeout() # get the timeout
server.isrunning() # check wether the server is running or not
diff --git a/tests/wipy/wlan/server.py b/tests/wipy/wlan/server.py
index c474de627..05847e376 100644
--- a/tests/wipy/wlan/server.py
+++ b/tests/wipy/wlan/server.py
@@ -9,7 +9,7 @@ mch = os.uname().machine
if not 'LaunchPad' in mch and not'WiPy' in mch:
raise Exception('Board not supported!')
-server = network.server()
+server = network.Server()
print(server.timeout() == 300)
print(server.isrunning() == True)