Skip to content

Add decorator for websocket server events #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions server.py
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
from websocket_server import WebsocketServer


PORT=9001
server = WebsocketServer(port = PORT)


# Called for every client connecting (after handshake)
@server.on_new_client()
def new_client(client, server):
print("New client connected and was given id %d" % client['id'])
server.send_message_to_all("Hey all, a new client has joined us")


# Called for every client disconnecting
@server.on_client_left()
def client_left(client, server):
print("Client(%d) disconnected" % client['id'])


# Called when a client sends a message
@server.on_message_received()
def message_received(client, server, message):
if len(message) > 200:
message = message[:200]+'..'
print("Client(%d) said: %s" % (client['id'], message))


PORT=9001
server = WebsocketServer(port = PORT)
server.set_fn_new_client(new_client)
server.set_fn_client_left(client_left)
server.set_fn_message_received(message_received)
server.run_forever()
29 changes: 24 additions & 5 deletions websocket_server/websocket_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

from websocket_server.thread import WebsocketServerThread

from typing import Callable

logger = logging.getLogger(__name__)
logging.basicConfig()

Expand Down Expand Up @@ -52,7 +54,6 @@


class API():

def run_forever(self, threaded=False):
return self._run_forever(threaded)

Expand All @@ -64,14 +65,32 @@ def client_left(self, client, server):

def message_received(self, client, server, message):
pass

def set_fn_new_client(self, fn):

def on_new_client(self):
def decorator(func: Callable):
self.set_fn_new_client(func)

return decorator

def on_client_left(self):
def decorator(func: Callable):
self.set_fn_client_left(func)

return decorator

def on_message_received(self):
def decorator(func: Callable):
self.set_fn_message_received(func)

return decorator

def set_fn_new_client(self, fn: Callable):
self.new_client = fn

def set_fn_client_left(self, fn):
def set_fn_client_left(self, fn: Callable):
self.client_left = fn

def set_fn_message_received(self, fn):
def set_fn_message_received(self, fn: Callable):
self.message_received = fn

def send_message(self, client, msg):
Expand Down