update interfaces

This commit is contained in:
zixuanzh 2018-10-14 14:11:03 -04:00
parent 278a2d3b34
commit a672a5017f
3 changed files with 19 additions and 3 deletions

View File

@ -1,4 +1,9 @@
from host_interface import Host from host_interface import Host
# Upon host creation, host takes in options,
# including the list of addresses on which to listen.
# Host then parses these options and delegates to its Network instance,
# telling it to listen on the given listen addresses.
class BasicHost(Host): class BasicHost(Host):
pass pass

View File

@ -33,17 +33,19 @@ class Host(ABC):
""" """
set stream handler for host set stream handler for host
:param protocol_id: protocol id used on stream :param protocol_id: protocol id used on stream
:param stream_handler: a stream handler instance :param stream_handler: a stream handler function
:return: true if successful :return: true if successful
""" """
pass pass
# protocol_id can be a list of protocol_ids
# stream will decide which protocol_id to run on
@abstractmethod @abstractmethod
def new_stream(self, context, peer_id, protocol_ids): def new_stream(self, context, peer_id, protocol_id):
""" """
:param context: a context instance :param context: a context instance
:param peer_id: peer_id that host is connecting :param peer_id: peer_id that host is connecting
:param proto_ids: list of protocol ids that stream runs on :param proto_id: protocol id that stream runs on
:return: true if successful :return: true if successful
""" """
pass pass

View File

@ -36,3 +36,12 @@ class Stream(ABC):
:return: number of bytes written :return: number of bytes written
""" """
pass pass
@abstractmethod
def close():
"""
close stream
:return: true if successful
"""
pass