From 347b3a3d1f7c44442c77af20f27cf67412063fc3 Mon Sep 17 00:00:00 2001
From: Paul Sokolovsky <pfalcon@users.sourceforge.net>
Date: Sat, 31 May 2014 01:48:26 +0300
Subject: [PATCH] modsocket: Add some comments on intended usage/API design of
module.
---
unix/modsocket.c | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/unix/modsocket.c b/unix/modsocket.c
index 5a90474db..d6f732377 100644
--- a/unix/modsocket.c
+++ b/unix/modsocket.c
@@ -50,6 +50,21 @@
#include "stream.h"
#include "builtin.h"
+/*
+ The idea of this module is to implement reasonable minimum of
+ socket-related functions to write typical clients and servers.
+ The module named "microsocket" on purpose, to allow to make
+ Python-level module more (or fully) compatible with CPython
+ "socket", e.g.:
+ ---- socket.py ----
+ from microsocket import *
+ from socket_more_funcs import *
+ from socket_more_funcs2 import *
+ -------------------
+ I.e. this module should stay lean, and more functions (if needed)
+ should be add to seperate modules (C or Python level).
+ */
+
#define MICROPY_SOCKET_EXTRA (0)
typedef struct _mp_obj_socket_t {
--
GitLab