kopia lustrzana https://github.com/cirospaciari/socketify.py
Removed html from examples.md and added references to api, _sidebar and README .md files. (#121)
* Created examples.md file in docs and added 4 examples. added backpressure, middleware, https and broadcast. * Removed html from examples.md and added referrences. added examples link to api.md, README.md and _sidebar.md. * Added next section. created link to examples.md file from api.md at the bottom.pull/122/head
rodzic
40404519e5
commit
1d57eff163
|
@ -38,3 +38,4 @@ With no precedents websocket performance and a really fast HTTP server that can
|
|||
- [SSL](ssl.md)
|
||||
- [CLI, ASGI and WSGI](cli.md)
|
||||
- [API Reference](api.md)
|
||||
- [Examples](examples.md)
|
||||
|
|
|
@ -16,3 +16,4 @@
|
|||
- [SSL](ssl.md)
|
||||
- [CLI, ASGI and WSGI](cli.md)
|
||||
- [API Reference](api.md)
|
||||
- [Examples](examples.md)
|
||||
|
|
|
@ -229,4 +229,7 @@ class MiddlewareRouter:
|
|||
def connect(self, path, handler):
|
||||
def trace(self, path, handler):
|
||||
def any(self, path, handler):
|
||||
```
|
||||
```
|
||||
|
||||
# Examples
|
||||
### Next [Examples](examples.md)
|
||||
|
|
|
@ -0,0 +1,158 @@
|
|||
# Examples
|
||||
|
||||
Middleware
|
||||
```python
|
||||
from socketify import App, middleware
|
||||
|
||||
|
||||
async def get_user(authorization):
|
||||
if authorization:
|
||||
# you can do something async here
|
||||
return {"greeting": "Hello, World"}
|
||||
return None
|
||||
|
||||
|
||||
async def auth(res, req, data=None):
|
||||
user = await get_user(req.get_header("authorization"))
|
||||
if not user:
|
||||
res.write_status(403).end("not authorized")
|
||||
# returning Falsy in middlewares just stop the execution of the next middleware
|
||||
return False
|
||||
|
||||
# returns extra data
|
||||
return user
|
||||
|
||||
|
||||
def another_middie(res, req, data=None):
|
||||
# now we can mix sync and async and change the data here
|
||||
if isinstance(data, dict):
|
||||
gretting = data.get("greeting", "")
|
||||
data["greeting"] = f"{gretting} from another middie ;)"
|
||||
return data
|
||||
|
||||
|
||||
def home(res, req, user=None):
|
||||
res.cork_end(user.get("greeting", None))
|
||||
|
||||
|
||||
app = App()
|
||||
app.get("/", middleware(auth, another_middie, home))
|
||||
app.listen(
|
||||
3000,
|
||||
lambda config: print("Listening on port http://localhost:%d now\n" % config.port),
|
||||
)
|
||||
app.run()
|
||||
|
||||
# You can also take a loop on MiddlewareRouter in middleware_router.py ;)
|
||||
```
|
||||
|
||||
Broadcast
|
||||
```python
|
||||
from socketify import App, AppOptions, OpCode, CompressOptions
|
||||
|
||||
|
||||
def ws_open(ws):
|
||||
print("A WebSocket got connected!")
|
||||
# Let this client listen to topic "broadcast"
|
||||
ws.subscribe("broadcast")
|
||||
|
||||
|
||||
def ws_message(ws, message, opcode):
|
||||
# Broadcast this message
|
||||
ws.publish("broadcast", message, opcode)
|
||||
|
||||
app = App()
|
||||
app.ws(
|
||||
"/*",
|
||||
{
|
||||
"compression": CompressOptions.SHARED_COMPRESSOR,
|
||||
"max_payload_length": 16 * 1024 * 1024,
|
||||
"idle_timeout": 60,
|
||||
"open": ws_open,
|
||||
"message": ws_message,
|
||||
# The library guarantees proper unsubscription at close
|
||||
"close": lambda ws, code, message: print("WebSocket closed"),
|
||||
"subscription": lambda ws, topic, subscriptions, subscriptions_before: print(f'subscription/unsubscription on topic {topic} {subscriptions} {subscriptions_before}'),
|
||||
},
|
||||
)
|
||||
app.any("/", lambda res, req: res.end("Nothing to see here!"))
|
||||
app.listen(
|
||||
3000,
|
||||
lambda config: print("Listening on port http://localhost:%d now\n" % (config.port)),
|
||||
)
|
||||
app.run()
|
||||
```
|
||||
|
||||
HTTPS
|
||||
```python
|
||||
from socketify import App, AppOptions
|
||||
|
||||
app = App(
|
||||
AppOptions(
|
||||
key_file_name="./misc/key.pem",
|
||||
cert_file_name="./misc/cert.pem",
|
||||
passphrase="1234",
|
||||
)
|
||||
)
|
||||
app.get("/", lambda res, req: res.end("Hello World socketify from Python!"))
|
||||
app.listen(
|
||||
54321,
|
||||
lambda config: print("Listening on port https://localhost:%d now\n" % config.port),
|
||||
)
|
||||
app.run()
|
||||
|
||||
# mkdir misc
|
||||
# openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -passout pass:1234 -keyout ./misc/key.pem -out ./misc/cert.pem
|
||||
```
|
||||
|
||||
Backpressure
|
||||
```python
|
||||
from socketify import App, AppOptions, OpCode, CompressOptions
|
||||
|
||||
# Number between ok and not ok
|
||||
backpressure = 1024
|
||||
|
||||
# Used for statistics
|
||||
messages = 0
|
||||
message_number = 0
|
||||
|
||||
|
||||
def ws_open(ws):
|
||||
print("A WebSocket got connected!")
|
||||
# We begin our example by sending until we have backpressure
|
||||
global message_number
|
||||
global messages
|
||||
while ws.get_buffered_amount() < backpressure:
|
||||
ws.send("This is a message, let's call it %i" % message_number)
|
||||
message_number = message_number + 1
|
||||
messages = messages + 1
|
||||
|
||||
|
||||
def ws_drain(ws):
|
||||
# Continue sending when we have drained (some)
|
||||
global message_number
|
||||
global messages
|
||||
while ws.get_buffered_amount() < backpressure:
|
||||
ws.send("This is a message, let's call it %i" % message_number)
|
||||
message_number = message_number + 1
|
||||
messages = messages + 1
|
||||
|
||||
|
||||
app = App()
|
||||
app.ws(
|
||||
"/*",
|
||||
{
|
||||
"compression": CompressOptions.DISABLED,
|
||||
"max_payload_length": 16 * 1024 * 1024,
|
||||
"idle_timeout": 60,
|
||||
"open": ws_open,
|
||||
"drain": ws_drain,
|
||||
},
|
||||
)
|
||||
app.any("/", lambda res, req: res.end("Nothing to see here!"))
|
||||
app.listen(
|
||||
3000,
|
||||
lambda config: print("Listening on port http://localhost:%d now\n" % (config.port)),
|
||||
)
|
||||
app.run()
|
||||
```
|
Ładowanie…
Reference in New Issue