From c144db49fd16cda06b964388ebbeb35a3b812cb5 Mon Sep 17 00:00:00 2001 From: Dirk Alders Date: Sun, 17 Aug 2025 11:18:50 +0200 Subject: [PATCH] docs update --- _docs_/.buildinfo | 4 - .../unittest.pdf | 0 _docs_/_sources/index.rst.txt | 24 - _docs_/_sources/tcp_socket.rst.txt | 7 + _docs_/genindex.html | 108 --- _docs_/index.html | 741 ------------------ _docs_/objects.inv | Bin 703 -> 242 bytes _docs_/search.html | 6 - _docs_/searchindex.js | 2 +- _docs_/{py-modindex.html => tcp_socket.html} | 58 +- 10 files changed, 31 insertions(+), 919 deletions(-) delete mode 100644 _docs_/.buildinfo delete mode 100644 _docs_/_downloads/6f8b274225e547e910ea349a3a9f4285/unittest.pdf delete mode 100644 _docs_/_sources/index.rst.txt create mode 100644 _docs_/_sources/tcp_socket.rst.txt delete mode 100644 _docs_/index.html rename _docs_/{py-modindex.html => tcp_socket.html} (86%) diff --git a/_docs_/.buildinfo b/_docs_/.buildinfo deleted file mode 100644 index 01855a8..0000000 --- a/_docs_/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: fd45e30e062c2ee3823dfe4442134a27 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_docs_/_downloads/6f8b274225e547e910ea349a3a9f4285/unittest.pdf b/_docs_/_downloads/6f8b274225e547e910ea349a3a9f4285/unittest.pdf deleted file mode 100644 index e69de29..0000000 diff --git a/_docs_/_sources/index.rst.txt b/_docs_/_sources/index.rst.txt deleted file mode 100644 index 35b2977..0000000 --- a/_docs_/_sources/index.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -.. documentation master file, created by - sphinx-quickstart on Fri Jan 1 19:56:01 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to cachings's documentation! -==================================== - -.. automodule:: tcp_socket - :members: - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/_docs_/_sources/tcp_socket.rst.txt b/_docs_/_sources/tcp_socket.rst.txt new file mode 100644 index 0000000..0bd247f --- /dev/null +++ b/_docs_/_sources/tcp_socket.rst.txt @@ -0,0 +1,7 @@ +tcp\_socket package +=================== + +.. automodule:: tcp_socket + :members: + :show-inheritance: + :undoc-members: diff --git a/_docs_/genindex.html b/_docs_/genindex.html index 381ff64..263bdd4 100644 --- a/_docs_/genindex.html +++ b/_docs_/genindex.html @@ -77,9 +77,6 @@
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • @@ -125,110 +122,8 @@

    Index

    - C - | I - | M - | R - | S - | T
    -

    C

    - - - -
    - -

    I

    - - - -
    - -

    M

    - - -
    - -

    R

    - - - -
    - -

    S

    - - -
    - -

    T

    - - - -
    -
    @@ -257,9 +152,6 @@
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • diff --git a/_docs_/index.html b/_docs_/index.html deleted file mode 100644 index e84bac0..0000000 --- a/_docs_/index.html +++ /dev/null @@ -1,741 +0,0 @@ - - - - - - - - Welcome to cachings’s documentation! — tcp_socket documentation - - - - - - - - - - - - - - - - - - - -
    - - -
    - -
    -
    - - - -
    -
    -
    -
    - -
    -

    Welcome to cachings’s documentation!

    -
    -

    tcp_socket (TCP Socket)

    -

    Author:

    - -

    Description:

    -
    -

    This Module supports a client/ server tcp socket connection.

    -
    -

    Submodules:

    - -

    Unittest:

    -
    -

    See also the unittest documentation.

    -
    -

    Module Documentation:

    -
    -
    -
    -class tcp_socket.tcp_base(host, port, channel_name=None, rx_tx_log_lvl=20)
    -

    This is the base class for other classes in this module.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    This class is not designed for direct usage.

    -
    -
    -
    -client_address()
    -

    This method returns the address of the connected client.

    -
    -
    Returns:
    -

    The client address.

    -
    -
    Return type:
    -

    str

    -
    -
    -
    - -
    -
    -close()
    -

    This method closes the connected communication channel, if exists.

    -
    - -
    -
    -init_channel_name(channel_name=None)
    -

    With this Method, the channel name for logging can be changed.

    -
    -
    Parameters:
    -

    channel_name (str) – The name for the logging channel

    -
    -
    -
    - -
    -
    -is_connected()
    -

    With this Method the connection status can be identified.

    -
    -
    Returns:
    -

    True, if a connection is established, otherwise False.

    -
    -
    Return type:
    -

    bool

    -
    -
    -
    - -
    -
    -receive(timeout=1, num=None)
    -

    This method returns received data.

    -
    -
    Parameters:
    -
      -

    • timeout (float) – The timeout for receiving data (at least after the timeout the method returns data or None).

      • -

    • num (int) – the number of bytes to receive (use None to get all available data).

      • -
    -
    -
    Returns:
    -

    The received data.

    -
    -
    Return type:
    -

    bytes

    -
    -
    -
    - -
    -
    -register_callback(callback)
    -

    This method stores the callback which is executed, if data is available. You need to execute receive() of this instance -given as first argument.

    -
    -
    Parameters:
    -

    callback – The callback which will be executed, when data is available.

    -
    -
    -
    - -
    -
    -register_connect_callback(callback)
    -

    This method stores the callback which is executed, if a connection is established.

    -
    -
    Parameters:
    -

    callback – The callback which will be executed, when a connection is established.

    -
    -
    -
    - -
    -
    -register_disconnect_callback(callback)
    -

    This method stores the callback which is executed, after the connection is lost.

    -
    -
    Parameters:
    -

    callback – The callback which will be executed, after the connection is lost.

    -
    -
    -
    - -
    -
    -send(data, timeout=1)
    -

    This method sends data via the initiated communication channel.

    -
    -
    Parameters:
    -
      -

    • data (bytes) – The data to be send over the communication channel.

      • -

    • timeout (float) – The timeout for sending data (e.g. time to establish new connection).

      • -
    -
    -
    Returns:
    -

    True if data had been sent, otherwise False.

    -
    -
    Return type:
    -

    bool

    -
    -
    -
    - -
    - -
    -
    -class tcp_socket.tcp_base_stp(host, port, channel_name=None)
    -

    This is the base class for other classes in this module. See also parent tcp_base.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    This class is not designed for direct usage.

    -
    -
    -
    -receive(timeout=1)
    -

    This method returns one received messages via the initiated communication channel.

    -
    -
    Parameters:
    -

    timeout (float) – The timeout for receiving data (at least after the timeout the method returns data or None).

    -
    -
    Returns:
    -

    The received data.

    -
    -
    Return type:
    -

    bytes

    -
    -
    -
    - -
    -
    -send(data, timeout=1)
    -

    This method sends one stp message via the initiated communication channel.

    -
    -
    Parameters:
    -
      -

    • data (bytes) – The message to be send over the communication channel.

      • -

    • timeout (float) – The timeout for sending data (e.g. time to establish new connection).

      • -
    -
    -
    Returns:
    -

    True if data had been sent, otherwise False.

    -
    -
    Return type:
    -

    bool

    -
    -
    -
    - -
    - -
    -
    -class tcp_socket.tcp_client(host, port, channel_name=None, rx_tx_log_lvl=20)
    -

    This class creates a tcp-client for transfering a serial stream of bytes (characters). See also parent tcp_base.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    You need a running tcp_server listening at the given IP and Port to be able to communicate.

    -
    -

    Example:

    -
    import sys                  # nopep8
-sys.path.append('../..')    # nopep8
-import tcp_socket
-import report
-
-
-def mirror_callback(data):
-    return data
-
-
-report.default_logging_config()
-c = tcp_socket.tcp_client('127.0.0.1', 17000)
-c.send(b'abc')
-print('The Client received: %s' % repr(c.receive()))
-
    -
    -
       DEBUG - tcp_socket.all_others - comm-client: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-client: Connection established... (to 127.0.0.1:17000)
-   DEBUG - tcp_socket.all_others - comm-client: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-client: TX -> "(3): 61 62 63"
-    INFO - tcp_socket.all_others - comm-client: RX <- "(3): 61 62 63"
-   DEBUG - tcp_socket.all_others - comm-client: Cleaning up receive-buffer
-The Client received: b'abc'
-
    -
    -
    - -
    -
    -class tcp_socket.tcp_client_stp(host, port, channel_name=None)
    -

    This class creates a tcp-client for transfering a message. The bytes will be packed on send and unpacked on receive. See also parents tcp_client and tcp_base_stp. -See stringtools.stp for more information on packing and unpacking.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    You need a running tcp_server_stp listening at the given IP and Port to be able to communicate.

    -
    -

    Example:

    -
    import sys                  # nopep8
-sys.path.append('../..')    # nopep8
-import tcp_socket
-import report
-
-
-def mirror_callback(data):
-    return data
-
-
-report.default_logging_config()
-c = tcp_socket.tcp_client_stp('127.0.0.1', 17017)
-c.send(b'abc')
-print('The Client received: %s' % repr(c.receive()))
-
    -
    -
       DEBUG - tcp_socket.all_others - comm-client: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-client: Connection established... (to 127.0.0.1:17017)
-   DEBUG - tcp_socket.all_others - comm-client: Cleaning up receive-buffer
-   DEBUG - tcp_socket.all_others - comm-client: TX -> "(7): 3a 3c 61 62 63 3a 3e"
-    INFO - tcp_socket.all_others - comm-client: TX -> "(3): 61 62 63"
-   DEBUG - tcp_socket.all_others - comm-client: RX <- "(7): 3a 3c 61 62 63 3a 3e"
-   DEBUG - stringtools.stp - STP: data sync (3a) received => changing state STP_STATE_IDLE -> STP_STATE_ESCAPE_1
-   DEBUG - stringtools.stp - STP: start pattern (3a 3c) received => changing state STP_STATE_ESCAPE_1 -> STP_STATE_STORE_DATA
-   DEBUG - stringtools.stp - STP: data sync (3a) received => changing state STP_STATE_STORE_DATA -> STP_STATE_ESCAPE_2
-   DEBUG - stringtools.stp - STP: end pattern (3a 3e) received => storing message and changing state STP_STATE_ESCAPE_2 -> STP_STATE_IDLE
-    INFO - stringtools.stp - STP: message identified - (3): 61 62 63
-    INFO - tcp_socket.all_others - comm-client: RX  <- "(3): 61 62 63"
-The Client received: b'abc'
-
    -
    -
    - -
    -
    -class tcp_socket.tcp_server(host, port, channel_name=None, rx_tx_log_lvl=20)
    -

    This class creates a tcp-server for transfering a serial stream of bytes (characters). See also parent tcp_base.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    You need a tcp_client to communicate with the server.

    -
    -

    Example:

    -
    import sys                  # nopep8
-sys.path.append('../..')    # nopep8
-import time
-import tcp_socket
-import report
-
-
-def mirror_callback(tcp):
-    tcp.send(tcp.receive())
-
-
-report.default_logging_config()
-s = tcp_socket.tcp_server('127.0.0.1', 17000)
-s.register_callback(mirror_callback)
-
-i = 0
-while not s.is_connected() and i <= 10:
-    i += 1
-    time.sleep(.1)  # wait for a connection
-
-i = 0
-while s.is_connected() and i <= 10:
-    i += 1
-    time.sleep(.1)  # wait for disconnect
-
    -
    -
       DEBUG - tcp_socket.all_others - comm-server: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-server: Server listening to 127.0.0.1:17000
-    INFO - tcp_socket.all_others - comm-server: Connection established... (from 127.0.0.1:17000)
-   DEBUG - tcp_socket.all_others - comm-server: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-server: RX <- "(3): 61 62 63"
-   DEBUG - tcp_socket.all_others - comm-server: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-server: TX -> "(3): 61 62 63"
-    INFO - tcp_socket.all_others - comm-server: Connection lost...
-    INFO - tcp_socket.all_others - comm-server: Server listening to 127.0.0.1:17000
-
    -
    -
    - -
    -
    -class tcp_socket.tcp_server_stp(host, port, channel_name=None)
    -

    This class creates a tcp-server for transfering a message. The bytes will be packed on send and unpacked on receive. See also parents tcp_server and tcp_base_stp. -See stringtools.stp for more information on packing and unpacking.

    -
    -
    Parameters:
    -
      -

    • host (str) – The host IP for the TCP socket functionality

      • -

    • port (int) – The port for the TCP socket functionality

      • -

    • channel_name (str) – The name for the logging channel

      • -
    -
    -
    -
    -

    Note

    -

    You need a tcp_client_stp to communicate with the server.

    -
    -

    Example:

    -
    import sys                  # nopep8
-sys.path.append('../..')    # nopep8
-import time
-import tcp_socket
-import report
-
-
-def mirror_callback(tcp):
-    tcp.send(tcp.receive())
-
-
-logger = report.default_logging_config()
-s = tcp_socket.tcp_server_stp('127.0.0.1', 17017)
-s.register_callback(mirror_callback)
-
-i = 0
-while not s.is_connected() and i <= 10:
-    i += 1
-    time.sleep(.1)  # wait for a connection
-
-i = 0
-while s.is_connected() and i <= 10:
-    i += 1
-    time.sleep(.1)  # wait for disconnect
-
    -
    -
       DEBUG - tcp_socket.all_others - comm-server: Cleaning up receive-buffer
-    INFO - tcp_socket.all_others - comm-server: Server listening to 127.0.0.1:17017
-    INFO - tcp_socket.all_others - comm-server: Connection established... (from 127.0.0.1:17017)
-   DEBUG - tcp_socket.all_others - comm-server: Cleaning up receive-buffer
-   DEBUG - tcp_socket.all_others - comm-server: RX <- "(7): 3a 3c 61 62 63 3a 3e"
-   DEBUG - stringtools.stp - STP: data sync (3a) received => changing state STP_STATE_IDLE -> STP_STATE_ESCAPE_1
-   DEBUG - stringtools.stp - STP: start pattern (3a 3c) received => changing state STP_STATE_ESCAPE_1 -> STP_STATE_STORE_DATA
-   DEBUG - stringtools.stp - STP: data sync (3a) received => changing state STP_STATE_STORE_DATA -> STP_STATE_ESCAPE_2
-   DEBUG - stringtools.stp - STP: end pattern (3a 3e) received => storing message and changing state STP_STATE_ESCAPE_2 -> STP_STATE_IDLE
-    INFO - stringtools.stp - STP: message identified - (3): 61 62 63
-    INFO - tcp_socket.all_others - comm-server: RX  <- "(3): 61 62 63"
-   DEBUG - tcp_socket.all_others - comm-server: TX -> "(7): 3a 3c 61 62 63 3a 3e"
-    INFO - tcp_socket.all_others - comm-server: TX -> "(3): 61 62 63"
-    INFO - tcp_socket.all_others - comm-server: Connection lost...
-    INFO - tcp_socket.all_others - comm-server: Server listening to 127.0.0.1:17017
-
    -
    -
    - -
    -
    -
    -
    -

    Indices and tables

    - -
    - - -
    -
    -
    -
    - -
    -
    - -
    - © - Copyright - 2025, Dirk Alders. -
    - This page is licensed under the Python Software Foundation License Version 2. -
    - Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. -
    - - -
    - - The Python Software Foundation is a non-profit corporation. -Please donate. -
    -
    - -
    - - Created using Sphinx 8.2.3. -
    - - - \ No newline at end of file diff --git a/_docs_/objects.inv b/_docs_/objects.inv index adc31e3ebae2a6ccd1934108820d8ad658486e67..9d8ab7718d0f43c86a17ccbea47d49bc4738dcc9 100644 GIT binary patch delta 129 zcmV-{0Dk|!1@ZxqczR1u&CAS7Nv%*QE=jScS)-ihc7_N^?@7dXQuZXbY$;$;i(`)m@yLSd^TBsu3av(Gv`j4@gW;t53;K2B}7fLUbUhDo9Mu25AHUTuWQ~6Yn?) delta 594 zcmV-Y00lx*1cz?B4y>8nu5Z?V1EZU(RBt>;l1VPXx$Y3BT0yscNfu=4N5sDOe zXT$E)*XZl@NlJ-HE2D8FN-{iHrtbSW>iEedstk>I0%FzvvNZWd0Xt(-=dg7*c+z_zDz@Queai)Uic&U?JlhLI!%Uwc@TW&I_8fa5%m(|@rRJL$Z|hXUB$;(^^t0orBr zNB84X54YBoTxZ(Nh~)}1_efpQ!A>a8h+gkH(0(|-@2BZQ^ce}P+_dkai}-UqKS~?A z>pe+ZUfrHQ8q1aqu($05c9if98Qhd5xBG;ktQ4nuHe0LB3w}TY0rUeVJxIf+-|2d2 z_)p!$^Gn~d({l9gRAA8LPZO8ZDxAKNVB#DA^)0pJgJ9)vR@oB#j- diff --git a/_docs_/search.html b/_docs_/search.html index 42e8793..de533a9 100644 --- a/_docs_/search.html +++ b/_docs_/search.html @@ -67,9 +67,6 @@
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • @@ -144,9 +141,6 @@
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • diff --git a/_docs_/searchindex.js b/_docs_/searchindex.js index 9927e1f..cb8e7a8 100644 --- a/_docs_/searchindex.js +++ b/_docs_/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"1. Copyright and Related Rights.":[[3,"copyright-and-related-rights"],[10,"copyright-and-related-rights"]],"2. Waiver.":[[3,"waiver"],[10,"waiver"]],"3. Public License Fallback.":[[3,"public-license-fallback"],[10,"public-license-fallback"]],"4. Limitations and Disclaimers.":[[3,"limitations-and-disclaimers"],[10,"limitations-and-disclaimers"]],"CC0 1.0 Universal licence":[[3,"cc0-1-0-universal-licence"],[10,"cc0-1-0-universal-licence"]],"Indices and tables":[[0,"indices-and-tables"]],"Licence":[[3,null],[10,null]],"License for Sphinx":[[4,null],[11,null]],"Statement of Purpose":[[3,"statement-of-purpose"],[10,"statement-of-purpose"]],"The MIT License (MIT)":[[2,null],[9,null]],"Welcome to cachings\u2019s documentation!":[[0,null]],"Zero-Clause BSD Licence":[[3,"zero-clause-bsd-licence"],[10,"zero-clause-bsd-licence"]],"tcp_socket (TCP Socket)":[[0,"tcp-socket-tcp-socket"]]},"docnames":["index","venv/lib/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE","venv/lib/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE","venv/lib/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE","venv/lib/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module","venv/lib64/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE","venv/lib64/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE","venv/lib64/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE","venv/lib64/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["index.rst","venv/lib/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE.rst","venv/lib/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst","venv/lib/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.rst","venv/lib/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst","venv/lib64/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE.rst","venv/lib64/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst","venv/lib64/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.rst","venv/lib64/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst"],"indexentries":{"client_address() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.client_address",false]],"close() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.close",false]],"init_channel_name() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.init_channel_name",false]],"is_connected() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.is_connected",false]],"module":[[0,"module-tcp_socket",false]],"receive() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.receive",false]],"receive() (tcp_socket.tcp_base_stp method)":[[0,"tcp_socket.tcp_base_stp.receive",false]],"register_callback() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.register_callback",false]],"register_connect_callback() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.register_connect_callback",false]],"register_disconnect_callback() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.register_disconnect_callback",false]],"send() (tcp_socket.tcp_base method)":[[0,"tcp_socket.tcp_base.send",false]],"send() (tcp_socket.tcp_base_stp method)":[[0,"tcp_socket.tcp_base_stp.send",false]],"tcp_base (class in tcp_socket)":[[0,"tcp_socket.tcp_base",false]],"tcp_base_stp (class in tcp_socket)":[[0,"tcp_socket.tcp_base_stp",false]],"tcp_client (class in tcp_socket)":[[0,"tcp_socket.tcp_client",false]],"tcp_client_stp (class in tcp_socket)":[[0,"tcp_socket.tcp_client_stp",false]],"tcp_server (class in tcp_socket)":[[0,"tcp_socket.tcp_server",false]],"tcp_server_stp (class in tcp_socket)":[[0,"tcp_socket.tcp_server_stp",false]],"tcp_socket":[[0,"module-tcp_socket",false]]},"objects":{"":[[0,0,0,"-","tcp_socket"]],"tcp_socket":[[0,1,1,"","tcp_base"],[0,1,1,"","tcp_base_stp"],[0,1,1,"","tcp_client"],[0,1,1,"","tcp_client_stp"],[0,1,1,"","tcp_server"],[0,1,1,"","tcp_server_stp"]],"tcp_socket.tcp_base":[[0,2,1,"","client_address"],[0,2,1,"","close"],[0,2,1,"","init_channel_name"],[0,2,1,"","is_connected"],[0,2,1,"","receive"],[0,2,1,"","register_callback"],[0,2,1,"","register_connect_callback"],[0,2,1,"","register_disconnect_callback"],[0,2,1,"","send"]],"tcp_socket.tcp_base_stp":[[0,2,1,"","receive"],[0,2,1,"","send"]]},"objnames":{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},"objtypes":{"0":"py:module","1":"py:class","2":"py:method"},"terms":{"":[3,10],"0":0,"1":0,"10":0,"11":[3,10],"127":0,"17000":0,"17017":0,"1996":[3,10],"20":0,"2007":[4,11],"2010":[1,8],"2011":[1,8],"2016":[2,9],"2020":[1,8],"2024":[3,10],"2025":[4,11],"3":0,"3a":0,"3c":0,"3e":0,"61":0,"62":0,"63":0,"7":0,"9":[3,10],"96":[3,10],"A":[1,2,3,4,8,9,10,11],"AND":[1,2,3,4,8,9,10,11],"AS":[1,2,3,4,8,9,10,11],"BE":[1,2,3,4,8,9,10,11],"BUT":[1,2,4,8,9,11],"BY":[1,4,8,11],"FOR":[1,2,3,4,8,9,10,11],"For":[3,10],"IF":[1,4,8,11],"IN":[1,2,3,4,8,9,10,11],"In":[3,10],"NO":[1,2,3,4,8,9,10,11],"NOT":[1,2,4,8,9,11],"No":[3,10],"OF":[1,2,3,4,8,9,10,11],"ON":[1,4,8,11],"OR":[1,2,3,4,8,9,10,11],"SUCH":[1,4,8,11],"THE":[1,2,3,4,8,9,10,11],"TO":[1,2,3,4,8,9,10,11],"The":[0,1,3,8,10],"These":[3,10],"To":[3,10],"WITH":[2,3,9,10],"With":0,"abandon":[3,10],"abc":0,"abl":0,"abov":[1,2,4,8,9,11],"absenc":[3,10],"account":[3,10],"accuraci":[3,10],"acknowledg":[3,10],"action":[2,3,9,10],"adam":[3,10],"adapt":[3,10],"addit":[3,10],"address":0,"advertis":[3,10],"advis":[1,4,8,11],"affect":[3,10],"affirm":[3,10],"after":0,"against":[3,10],"alder":0,"all":[0,2,3,4,9,10,11],"all_oth":0,"also":0,"amend":[3,10],"an":[2,3,9,10],"ani":[1,2,3,4,8,9,10,11],"append":0,"appli":[3,10],"applic":[3,10],"ar":[1,3,4,8,10,11],"argument":0,"aris":[1,2,3,4,8,9,10,11],"armin":[1,8],"assert":[3,10],"associ":[2,3,9,10],"author":[0,2,3,4,9,10,11],"authorship":[3,10],"automat":[3,10],"avail":[0,3,10],"b":0,"base":[0,1,3,8,10],"been":0,"below":[3,4,10,11],"benefit":[3,10],"binari":[1,4,8,11],"block":[7,14],"bool":0,"bsd":[4,11],"buffer":0,"build":[3,10],"busi":[1,4,8,11],"byte":0,"c":[0,1,3,4,8,10,11],"callback":0,"can":[0,3,10],"cancel":[3,10],"case":[3,10],"caus":[1,3,4,8,10,11],"certain":[3,10],"chang":0,"channel":0,"channel_nam":0,"charact":0,"charg":[2,9],"claim":[2,3,9,10],"class":0,"claus":[4,11],"clean":0,"clear":[3,10],"client":0,"client_address":0,"close":0,"code":[1,4,8,11],"comm":0,"commerci":[3,10],"common":[3,10],"commun":[0,3,10],"compens":[3,10],"competit":[3,10],"concern":[3,10],"condit":[1,2,4,8,9,11],"confer":[3,10],"connect":[0,2,3,9,10],"consent":[3,10],"consequenti":[1,3,4,8,10,11],"consider":[3,10],"contempl":[3,10],"contract":[1,2,3,4,8,9,10,11],"contrari":[3,10],"contravent":[3,10],"contribut":[3,10],"contributor":[1,4,8,11],"copi":[2,3,9,10],"copyright":[1,2,4,8,9,11],"correspond":[3,10],"council":[3,10],"creat":0,"creativ":[3,10],"creator":[3,10],"cultur":[3,10],"current":[3,10],"damag":[1,2,3,4,8,9,10,11],"data":[0,1,3,4,8,10,11],"databas":[3,10],"date":[3,10],"de":0,"deal":[2,9],"debug":0,"deem":[3,10],"def":0,"default_logging_config":0,"defect":[3,10],"defin":[3,10],"depict":[3,10],"deriv":[1,8],"descript":0,"design":0,"detriment":[3,10],"direct":[0,1,3,4,8,10,11],"dirk":0,"disclaim":[1,4,8,11],"disconnect":0,"discover":[3,10],"displai":[3,10],"disrupt":[3,10],"dissemin":[3,10],"distribut":[1,2,3,4,8,9,10,11],"do":[2,9],"document":[1,2,3,4,8,9,10,11],"durat":[3,10],"duti":[3,10],"e":0,"each":[3,10],"ec":[3,10],"effect":[3,10],"effort":[3,10],"either":[3,10],"elect":[3,10],"end":0,"endblock":[7,14],"endfor":[7,14],"endif":[7,14],"endors":[1,8],"enjoy":[3,10],"equit":[3,10],"equival":[3,10],"error":[3,10],"escap":[5,6,7,12,13,14],"establish":0,"european":[3,10],"even":[1,4,8,11],"event":[1,2,3,4,8,9,10,11],"exampl":0,"exclus":[3,10],"execut":0,"exemplari":[1,4,8,11],"exercis":[3,10],"exist":[0,3,10],"expect":[3,10],"express":[1,2,3,4,8,9,10,11],"extens":[3,10],"extent":[3,10],"extract":[3,10],"fals":0,"fear":[3,10],"fee":[3,10],"file":[2,4,9,11],"first":0,"fit":[1,2,3,4,8,9,10,11],"float":0,"follow":[1,2,3,4,8,9,10,11],"forcier":[1,8],"form":[1,3,4,8,10,11],"free":[2,3,9,10],"freeli":[3,10],"from":[0,1,2,3,8,9,10],"fulli":[3,10],"fullnam":[5,6,7,12,13,14],"function":0,"furnish":[2,9],"further":[3,10],"futur":[3,10],"g":0,"gain":[3,10],"get":0,"given":0,"good":[1,4,8,11],"grant":[2,3,9,10],"greater":[3,10],"greatest":[3,10],"ha":[3,10],"had":0,"he":[3,10],"heir":[3,10],"held":[3,10],"her":[3,10],"herebi":[2,3,9,10],"hi":[3,10],"holder":[1,2,4,8,9,11],"host":0,"howev":[1,4,8,11],"i":[0,1,2,3,4,8,9,10,11],"ideal":[3,10],"identifi":0,"ii":[3,10],"iii":[3,10],"imag":[3,10],"implement":[3,10],"impli":[1,2,3,4,8,9,10,11],"import":0,"incident":[1,4,8,11],"includ":[1,2,3,4,8,9,10,11],"incorpor":[3,10],"index":0,"indic":[4,11],"indirect":[1,3,4,8,10,11],"ineffect":[3,10],"info":0,"inform":0,"infring":[3,10],"init_channel_nam":0,"initi":0,"instanc":0,"int":0,"intend":[3,10],"interrupt":[1,4,8,11],"invalid":[3,10],"ip":0,"irrevoc":[3,10],"is_connect":0,"item":[7,14],"its":[3,10],"iv":[3,10],"jeff":[1,8],"judg":[3,10],"jurisdict":[3,10],"kenneth":[1,8],"kind":[2,3,9,10],"knowledg":[3,10],"known":[3,10],"larg":[3,10],"latent":[3,10],"later":[3,10],"law":[3,10],"least":0,"legal":[3,10],"liabil":[1,2,4,8,9,11],"liabl":[1,2,3,4,8,9,10,11],"licenc":[4,11],"like":[3,10],"limit":[1,2,4,8,9,11],"list":[1,4,8,11],"listen":0,"log":0,"logger":0,"loss":[1,3,4,8,10,11],"lost":0,"made":[3,10],"mai":[1,3,8,10],"make":[3,10],"march":[3,10],"materi":[1,4,8,11],"maximum":[3,10],"mean":[3,10],"medium":[3,10],"member":[3,10],"merchant":[1,2,3,4,8,9,10,11],"merg":[2,9],"messag":0,"met":[1,4,8,11],"method":0,"mirror_callback":0,"mockeri":0,"modif":[1,4,8,11],"modifi":[2,3,9,10],"modul":[0,7,14],"moral":[3,10],"more":0,"most":[3,10],"motiv":[3,10],"mount":0,"must":[1,4,8,11],"name":[0,1,8],"nation":[3,10],"necessari":[3,10],"need":0,"neglig":[1,3,4,8,10,11],"neighbor":[3,10],"new":0,"non":[3,10],"none":0,"noninfring":[2,9],"nopep8":0,"notic":[1,2,4,8,9,11],"now":[3,10],"num":0,"number":[0,3,10],"oblig":[3,10],"obtain":[2,3,9,10],"offer":[3,10],"one":0,"origin":[1,3,8,10],"other":[0,1,2,3,4,8,9,10,11],"otherwis":[0,1,2,3,4,8,9,10,11],"out":[1,2,3,4,8,9,10,11],"over":0,"overtli":[3,10],"owner":[1,3,8,10],"pack":0,"page":0,"paragraph":[3,10],"paramet":0,"parent":0,"parliament":[3,10],"part":[3,10],"parti":[3,10],"partial":[3,10],"particular":[1,2,3,4,8,9,10,11],"patent":[3,10],"path":0,"pattern":0,"perform":[3,10],"perman":[3,10],"permiss":[1,2,3,8,9,10],"permit":[1,2,3,4,8,9,10,11],"person":[2,3,9,10],"pertain":[3,10],"port":0,"portion":[2,9],"possibl":[1,3,4,8,10,11],"present":[3,10],"preserv":[3,10],"print":0,"prior":[1,8],"privaci":[3,10],"procur":[1,4,8,11],"product":[1,3,8,10],"profit":[1,3,4,8,10,11],"project":[3,4,10,11],"promot":[1,3,8,10],"protect":[3,10],"provid":[1,2,3,4,8,9,10,11],"publicli":[3,10],"publish":[2,9],"purpos":[1,2,4,8,9,11],"quiet":[3,10],"reason":[3,10],"receiv":0,"redistribut":[1,3,4,8,10,11],"regard":[3,10],"register_callback":0,"register_connect_callback":0,"register_disconnect_callback":0,"reitz":[1,8],"reliabl":[3,10],"relinquish":[3,10],"remain":[3,10],"remaind":[3,10],"report":0,"repr":0,"represent":[3,10],"reproduc":[1,3,4,8,10,11],"reput":[3,10],"requir":[3,10],"resciss":[3,10],"reserv":[1,4,8,11],"respect":[3,10],"respons":[3,10],"restrict":[2,9],"result":[3,10],"retain":[1,3,4,8,10,11],"return":0,"reus":[3,10],"revoc":[3,10],"right":[1,2,4,8,9,11],"ronach":[1,8],"royalti":[3,10],"rubric":[7,14],"run":0,"rx":0,"rx_tx_log_lvl":0,"scientif":[3,10],"search":0,"see":[0,4,11],"sell":[2,9],"send":0,"sent":0,"serial":0,"server":0,"servic":[1,4,8,11],"shall":[1,2,3,4,8,9,10,11],"she":[3,10],"shibukawa":[2,9],"should":[3,10],"similar":[3,10],"sleep":0,"so":[2,3,9,10],"softwar":[1,2,3,4,8,9,10,11],"some":[1,8],"sourc":[1,4,8,11],"special":[1,3,4,8,10,11],"specif":[1,8],"start":0,"state":0,"statu":0,"statutori":[3,10],"store":0,"stp":0,"stp_state_escape_1":0,"stp_state_escape_2":0,"stp_state_idl":0,"stp_state_store_data":0,"str":0,"stream":0,"strict":[1,4,8,11],"stringtool":0,"subject":[2,3,9,10],"sublicens":[2,3,9,10],"submodul":0,"subsequ":[3,10],"substanti":[2,9],"substitut":[1,4,8,11],"successor":[3,10],"sudo":0,"support":0,"surrend":[3,10],"sy":0,"sync":0,"take":[3,10],"tcp_base":0,"tcp_base_stp":0,"tcp_client":0,"tcp_client_stp":0,"tcp_server":0,"tcp_server_stp":0,"team":[4,11],"term":[3,10],"termin":[3,10],"territori":[3,10],"theme":[1,8],"theori":[1,4,8,11],"thereof":[3,10],"thi":[0,1,2,3,4,8,9,10,11],"those":[3,10],"through":[3,10],"throughout":[3,10],"time":[0,3,10],"timeout":0,"titl":[3,10],"tort":[1,2,4,8,9,11],"tortiou":[3,10],"trademark":[3,10],"transfer":[0,3,10],"translat":[3,10],"treati":[3,10],"true":0,"turner":[3,10],"two":[4,11],"tx":0,"type":0,"uncondit":[3,10],"uncondition":[3,10],"under":[3,4,10,11],"underlin":[5,6,7,12,13,14],"understand":[3,10],"unfair":[3,10],"unittest":0,"unknown":[3,10],"unless":[4,11],"unpack":0,"up":0,"upon":[3,10],"us":[0,1,2,3,4,8,9,10,11],"usag":0,"version":[3,10],"via":0,"voluntarili":[3,10],"wa":[3,10],"wai":[1,4,8,11],"wait":0,"waiv":[3,10],"warranti":[1,2,3,4,8,9,10,11],"well":[3,10],"whatsoev":[3,10],"when":0,"whether":[1,2,3,4,8,9,10,11],"which":0,"while":0,"whom":[2,9],"wish":[3,10],"without":[1,2,3,4,8,9,10,11],"work":[1,3,8,10],"world":[3,10],"worldwid":[3,10],"written":[1,8],"yoshiki":[2,9],"you":0},"titles":["Welcome to cachings\u2019s documentation!","<no title>","The MIT License (MIT)","Licence","License for Sphinx","<no title>","<no title>","<no title>","<no title>","The MIT License (MIT)","Licence","License for Sphinx","<no title>","<no title>","<no title>"],"titleterms":{"":0,"0":[3,10],"1":[3,10],"2":[3,10],"3":[3,10],"4":[3,10],"The":[2,9],"bsd":[3,10],"cach":0,"cc0":[3,10],"claus":[3,10],"copyright":[3,10],"disclaim":[3,10],"document":0,"fallback":[3,10],"indic":0,"licenc":[3,10],"licens":[2,3,4,9,10,11],"limit":[3,10],"mit":[2,9],"public":[3,10],"purpos":[3,10],"relat":[3,10],"right":[3,10],"socket":0,"sphinx":[4,11],"statement":[3,10],"tabl":0,"tcp":0,"tcp_socket":0,"univers":[3,10],"waiver":[3,10],"welcom":0,"zero":[3,10]}}) \ No newline at end of file +Search.setIndex({"alltitles":{"tcp_socket package":[[0,null]]},"docnames":["tcp_socket"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["tcp_socket.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{},"titles":["tcp_socket package"],"titleterms":{"packag":0,"tcp_socket":0}}) \ No newline at end of file diff --git a/_docs_/py-modindex.html b/_docs_/tcp_socket.html similarity index 86% rename from _docs_/py-modindex.html rename to _docs_/tcp_socket.html index 2a38bc1..8814c28 100644 --- a/_docs_/py-modindex.html +++ b/_docs_/tcp_socket.html @@ -3,8 +3,9 @@ - - Python Module Index — tcp_socket documentation + + + tcp_socket package — tcp_socket documentation @@ -16,19 +17,12 @@ - - + - - - -
    @@ -64,6 +58,13 @@ +
    +

    This Page

    + +
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • @@ -98,7 +96,7 @@ tcp_socket documentation »
    • -
  • Python Module Index
    • +
  • tcp_socket package
  • @@ -128,23 +126,9 @@
    - -

    Python Module Index

    - -
    - t -
    - - - - - - - -
     
    - t
    - tcp_socket -
    +
    +

    tcp_socket package

    +
    @@ -153,6 +137,13 @@
  • index
    • -
  • - modules |
  • Python logo
  • Python »
  • @@ -187,7 +175,7 @@ tcp_socket documentation »
    • -
  • Python Module Index
    • +
  • tcp_socket package