Added participants documentation
This commit is contained in:
parent
b0a6c1f528
commit
1dab3f4bc7
@ -69,6 +69,12 @@ class Participant:
|
||||
|
||||
@staticmethod
|
||||
def GetParticipant(arg1: Union[str, int], port: Optional[int] = None) -> Optional['Participant']:
|
||||
"""! Retrieve a participant
|
||||
@param arg1 Either:
|
||||
- str: The IP address of the participant
|
||||
- int: The network ID of the participant
|
||||
@param port The port number of the participant
|
||||
"""
|
||||
if port is not None:
|
||||
ip_address = str(arg1)
|
||||
for participant in Participant.participants:
|
||||
@ -83,6 +89,12 @@ class Participant:
|
||||
return None
|
||||
|
||||
def AddParticipant(arg1: Union[str, 'Participant'], port: Optional[int] = None) -> 'Participant':
|
||||
"""! Add a participant
|
||||
@param arg1 Either:
|
||||
- str: The IP address of the participant
|
||||
- Participant: The participant to add
|
||||
@param port The port number of the participant
|
||||
"""
|
||||
if port is not None:
|
||||
ip_address = str(arg1)
|
||||
participant = Participant(ip_address, port)
|
||||
|
Loading…
x
Reference in New Issue
Block a user