py-libp2p/host/host_interface.py
stuckinaboot 7fa674dee2
Protocol muxing (#82)
* Implement protocol muxing

* Integrate protocol muxing into new stream and listen's conn handler

* Fix bugs in protocol muxing

* Remove blank line

* Add comments and fix linting issues

* Fix order of parameters to select_one_of to match interface

* Use array of protocol ids in new stream instead of protocol id

* Add basic protocol muxer tests

* Add todo

* Modify new stream to take in protocol ids

* Add check to all tests to ensure protocol id is saved to net stream properly

* Lint tests

* Fix lint issues

* Add todo

* Modify port numbers in tests

* Fix linting issues

* Add more documentation to functions

* Add docs describing classes and fix indent error
2018-11-28 13:51:50 -05:00

42 lines
1020 B
Python

from abc import ABC, abstractmethod
class IHost(ABC):
@abstractmethod
def get_id(self):
"""
:return: peer_id of host
"""
@abstractmethod
def get_network(self):
"""
:return: network instance of host
"""
@abstractmethod
def get_mux(self):
"""
:return: mux instance of host
"""
@abstractmethod
def set_stream_handler(self, protocol_id, stream_handler):
"""
set stream handler for host
:param protocol_id: protocol id used on stream
:param stream_handler: a stream handler function
:return: true if successful
"""
# protocol_id can be a list of protocol_ids
# stream will decide which protocol_id to run on
@abstractmethod
def new_stream(self, peer_id, protocol_ids):
"""
:param peer_id: peer_id that host is connecting
:param protocol_ids: protocol ids that stream can run on
:return: true if successful
"""