Skip to content

Commit fd49f88

Browse files
committed
documentation update
1 parent 93b769d commit fd49f88

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

docs/extensions.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,19 @@ http3
3535
~~~~~
3636

3737
.. automodule:: rsocket.transports.http3_transport
38+
:members:
39+
40+
Routing
41+
-------
42+
43+
RequestRouter
44+
~~~~~~~~~~~~~
45+
46+
.. automodule:: rsocket.routing.request_router
47+
:members:
48+
49+
RoutingRequestHandler
50+
~~~~~~~~~~~~~~~~~~~~~
51+
52+
.. automodule:: rsocket.routing.routing_request_handler
3853
:members:

rsocket/routing/request_router.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ def decorator(function: decorated_method):
2222

2323

2424
class RequestRouter:
25+
"""
26+
Used to define routes for RSocket endpoints.
27+
28+
Pass this to :class:`RoutingRequestHandler <rsocket.routing.routing_request_handler.RoutingRequestHandler>`
29+
to instantiate a handler using these routes.
30+
"""
31+
2532
__slots__ = (
2633
'_channel_routes',
2734
'_stream_routes',

rsocket/routing/routing_request_handler.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020

2121

2222
class RoutingRequestHandler(BaseRequestHandler):
23+
"""
24+
Handler implementation which uses a :class:`RequestRouter <rsocket.routing.request_router.RequestRouter>`
25+
to handle requests based on route information provided in the payload metadata.
26+
"""
27+
2328
__slots__ = (
2429
'router',
2530
'data_encoding',

0 commit comments

Comments
 (0)