class Socket_Address

A simple place to store and manipulate tcp and port address for communication layer

Inheritance diagram

Inheritance diagram of Socket_Address

GetIPAddressRaw() → int

Returns a raw 32-bit unsigned integer representing the IPv4 address.

Deprecated: Does not work with IPv6 addresses.

__init__(inaddr: Socket_Address) → None
__init__(port: int) → None

Constructor that lets us set a port value

clear() → None

Set the internal values to a suitable known value

getFamily() → sa_family_t

Returns AF_INET if this is an IPv4 address, or AF_INET6 if this is an IPv6 address.

Return type


getIp() → str

Return the IP address portion in dot notation string.

getIpPort() → str

Return the ip address/port in dot notation string. If this is an IPv6 address, it will be enclosed in square brackets.

getPort() → int

Get the port portion as an integer

isAny() → bool

True if the address is zero.

isMcastRange() → bool

True if the address is in the multicast range.

setAnyIP(port: int) → bool

Set to any address and a specified port

setAnyIPv6(port: int) → bool

Set to any IPv6 address and a specified port.

setBroadcast(port: int) → bool

Set to the broadcast address and a specified port

setHost(hostname: str) → bool

Initializes the address from a string specifying both the address and port, separated by a colon. An IPv6 address must be enclosed in brackets.

setHost(hostname: str, port: int) → bool

This function will take a port and string-based TCP address and initialize the address with this information. Returns true on success; on failure, it returns false and the address may be undefined.

setHost(ip4addr: uint32_t, port: int) → bool
setPort(port: int) → bool

Set to a specified port