mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
4e2b83c052
* [V3 Docs] bump version * Remove removed functions from __all__ * Update docstring format * Update copyright year * Add embed utils docs * Document bot class * Document RPC * Update toctree
89 lines
1.6 KiB
Python
89 lines
1.6 KiB
Python
import asyncio
|
|
|
|
from aiohttp.web import Application
|
|
from aiohttp_json_rpc import JsonRpc
|
|
|
|
import logging
|
|
|
|
from .utils import TYPE_CHECKING, NewType
|
|
|
|
if TYPE_CHECKING:
|
|
from .bot import Red
|
|
|
|
log = logging.getLogger('red.rpc')
|
|
JsonSerializable = NewType('JsonSerializable', dict)
|
|
|
|
_rpc = JsonRpc(logger=log)
|
|
|
|
_rpc_server = None # type: asyncio.AbstractServer
|
|
|
|
|
|
async def initialize(bot: "Red"):
|
|
global _rpc_server
|
|
|
|
app = Application(loop=bot.loop)
|
|
app.router.add_route('*', '/rpc', _rpc)
|
|
|
|
handler = app.make_handler()
|
|
|
|
_rpc_server = await bot.loop.create_server(handler, '127.0.0.1', 6133)
|
|
|
|
log.debug('Created RPC _rpc_server listener.')
|
|
|
|
|
|
def add_topic(topic_name: str):
|
|
"""
|
|
Adds a topic for clients to listen to.
|
|
|
|
Parameters
|
|
----------
|
|
topic_name
|
|
"""
|
|
_rpc.add_topics(topic_name)
|
|
|
|
|
|
def notify(topic_name: str, data: JsonSerializable):
|
|
"""
|
|
Publishes a notification for the given topic name to all listening clients.
|
|
|
|
data MUST be json serializable.
|
|
|
|
note::
|
|
|
|
This method will fail silently.
|
|
|
|
Parameters
|
|
----------
|
|
topic_name
|
|
data
|
|
"""
|
|
_rpc.notify(topic_name, data)
|
|
|
|
|
|
def add_method(prefix, method):
|
|
"""
|
|
Makes a method available to RPC clients. The name given to clients will be as
|
|
follows::
|
|
|
|
"{}__{}".format(prefix, method.__name__)
|
|
|
|
note::
|
|
|
|
This method will fail silently.
|
|
|
|
Parameters
|
|
----------
|
|
prefix
|
|
method
|
|
MUST BE A COROUTINE OR OBJECT.
|
|
"""
|
|
_rpc.add_methods(
|
|
('', method),
|
|
prefix=prefix
|
|
)
|
|
|
|
|
|
def clean_up():
|
|
if _rpc_server is not None:
|
|
_rpc_server.close()
|