mirror of
https://github.com/SantaSpeen/winConnect.git
synced 2026-02-16 10:30:44 +00:00
update TODOs
This commit is contained in:
34
README.md
34
README.md
@@ -3,8 +3,20 @@ Communicate Client-Server via Windows NamedPipe
|
||||
|
||||
## ToDo:
|
||||
|
||||
- [x] Add support for sending and receiving data (0.1.0)
|
||||
- [x] Add support for safe closing (0.9.0)
|
||||
- [x] Basic class structure
|
||||
- [x] WinConnectBase (0.1.0)
|
||||
- [ ] WinConnectNamedPipe
|
||||
- [ ] WinConnectTCPSocket
|
||||
- [x] WinConnectDaemon (0.1.0)
|
||||
- [x] WinConnectClient (0.1.0)
|
||||
- [x] NamedPipe support: (Windows Only)
|
||||
- [x] Using pywin32pipe (0.1.0)
|
||||
- [x] Add support for sending and receiving data (0.1.0)
|
||||
- [x] Add support for safe closing (0.9.0)
|
||||
- [ ] TPCSocket support: (Universal)
|
||||
- [ ] Using socket
|
||||
- [ ] Add support for sending and receiving data
|
||||
- [ ] Add support for safe closing
|
||||
- [x] Add support for other header settings (0.9.0)
|
||||
- [x] Add logging (0.9.1)
|
||||
- [x] Send data in chunks (if data is too large) (0.9.3)
|
||||
@@ -17,16 +29,16 @@ Communicate Client-Server via Windows NamedPipe
|
||||
|
||||
## Description
|
||||
|
||||
This is a simple client-server communication system for Windows. The client and server communicate via a named pipe. The client sends a message to the server, and the server responds with a message. The client and server can be run on the same machine or on different machines.
|
||||
This is a simple client-server communication system.
|
||||
The client and server communicate via a named pipe (or TCP Socket).
|
||||
The server listens for incoming messages from clients and sends a response.
|
||||
|
||||
## Installation
|
||||
|
||||
To install the package, use the following command:
|
||||
|
||||
```bash
|
||||
|
||||
pip install winConnect
|
||||
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -38,15 +50,15 @@ You can find examples in the [examples](examples) directory.
|
||||
The server is a daemon that listens for incoming messages from clients. The server can be run on the same machine as the client or on a different machine. To run the server, use the following command:
|
||||
|
||||
```python
|
||||
from winConnect import WinConnectDaemon
|
||||
from winConnect import WinConnectServer
|
||||
|
||||
connector = WinConnectDaemon('test') # test - name of the pipe
|
||||
connector = WinConnectServer('test') # test - name of the pipe
|
||||
|
||||
for data in connector.listen():
|
||||
print(f"({type(data)}) {data=}")
|
||||
if data is None and connector.closed:
|
||||
break
|
||||
connector.send_data(data)
|
||||
print(f"({type(data)}) {data=}")
|
||||
if data is None and connector.closed:
|
||||
break
|
||||
connector.send_data(data)
|
||||
```
|
||||
|
||||
### Client
|
||||
|
||||
Reference in New Issue
Block a user