Skip to main content

A lightweight WebSocket-based communication library

Project description

Lazy Socket

An attempt at creating a websocket based communication system that handles all the threading and async stuff in the background.

Installation

pip install lazy-socket

Usage

Server

The server can be created by subclassing LazyServer and implementing the process_message method. This is an async method that will be called whenever a message is received from a client. To respond to the client, use the send method of the client object passed to the method. A list of clients is available via the clients attribute of the server.

import asyncio
from lazy_socket.server import LazyServer


class Server(LazyServer):

    async def process_message(self, client, message):
        await client.send(f"Received: {message}")

if __name__ == "__main__":
    server = Server(name="TestServer", host="0.0.0.0", port=5000, version="1.0")

    try:
        server.start()
    except KeyboardInterrupt:
        print("Shutting down server...")

Client

The client can be created by instantiating the LazyClient class. The client has a queue attribute that can be used to receive messages from the server. The client must be started using the start method. Messages can be sent to the server using the send method.

A message lazy_client:connected:{uri} is sent to the queue when the client successfully connects to the server.

from lazy_socket.client import LazyClient

client = LazyClient()
client.start()

while True:
    if client.queue.empty():
        continue

    message = client.queue.get()
    if message.startswith("lazy_client:connected:"): 
        client.send("Hello, Lazy Server!")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lazy_socket-0.0.4.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lazy_socket-0.0.4-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file lazy_socket-0.0.4.tar.gz.

File metadata

  • Download URL: lazy_socket-0.0.4.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for lazy_socket-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6800f04ece5a4fa0a6b06b2fe7a0536abf0e67859461cf7eebe2cbfd79958ffe
MD5 dfba6591bb166f09c2f4e88ae50ec792
BLAKE2b-256 201f225c173e81a8f5d2733d05fef913c2dded6cf49a3d0db19e6f749a653095

See more details on using hashes here.

File details

Details for the file lazy_socket-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: lazy_socket-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for lazy_socket-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8a8572a647184277dc11e62ceee73bfc0de72d2dda66bf2f0f43f2cd8f14c1ac
MD5 69680f37533e5acc2774bb8bf03f78f6
BLAKE2b-256 b10caca410afee8064d16440ade7999534feeddbbaba0643c42bca3aa7028337

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page