py-libp2p/libp2p/protocol_muxer/multiselect_muxer_interface.py

39 lines
1.2 KiB
Python
Raw Normal View History

from abc import ABC, abstractmethod
2019-08-08 14:22:06 +08:00
from typing import Dict, Tuple
2019-08-07 18:02:30 +08:00
from libp2p.typing import StreamHandlerFn, TProtocol
from .multiselect_communicator_interface import IMultiselectCommunicator
2019-01-10 02:38:56 +08:00
class IMultiselectMuxer(ABC):
"""Multiselect module that is responsible for responding to a multiselect
client and deciding on a specific protocol and handler pair to use for
communication."""
2019-08-07 18:02:30 +08:00
handlers: Dict[TProtocol, StreamHandlerFn]
@abstractmethod
2019-08-07 18:02:30 +08:00
def add_handler(self, protocol: TProtocol, handler: StreamHandlerFn) -> None:
"""
Store the handler with the given protocol.
:param protocol: protocol name
:param handler: handler function
"""
def get_protocols(self) -> Tuple[TProtocol, ...]:
return tuple(self.handlers.keys())
@abstractmethod
async def negotiate(
self, communicator: IMultiselectCommunicator
) -> Tuple[TProtocol, StreamHandlerFn]:
"""
Negotiate performs protocol selection.
:param stream: stream to negotiate on
:return: selected protocol name, handler function
:raise Exception: negotiation failed exception
"""