local_port Property

The TCP port in the local host where the class binds.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

0

Remarks

The local_port property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the class to choose a port at random. The chosen port will be shown by the local_port property after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set the local_port property when a connection is active will generate an error.

Use this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned. Furthermore, the class always attempts to bind to a secure (sub 1000) port when the value of local_port is the default (0). If you supply your own value, make sure the remote system is configured to allow that particular value.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8161]